Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .github/workflows/main.yml
Original file line number Diff line number Diff line change
Expand Up @@ -35,11 +35,11 @@ jobs:
- name: Install Dependencies
run: |
python -m pip install --upgrade pip
pip install -r requirements.txt
pip install -r src/requirements.txt

- name: Build Jupyter Book HTML
run: |
jupyter-book build .
jupyter-book build src/

- name: Setup Pages
uses: actions/configure-pages@v5
Expand Down
21 changes: 15 additions & 6 deletions _config.yml → src/_config.yml
Original file line number Diff line number Diff line change
@@ -1,10 +1,13 @@
# Book settings

title: Scholarly API Cookbook
author: The University of Alabama Libraries
copyright: "2025"
copyright: "2026"
logo: images/UALIB_logo.png
exclude_patterns: [readme.md, old, conversion_scripts]
exclude_patterns:
- readme.md
- old
- conversion_scripts

# Force re-execution of notebooks on each build.
# See https://jupyterbook.org/content/execute.html
execute:
Expand All @@ -16,13 +19,13 @@ latex:
targetname: book.tex

# Add a bibtex file so that we can create citations
#bibtex_bibfiles:
# - references.bib
# bibtex_bibfiles:
# - references.bib

# Information about where the book exists on the web
repository:
url: https://github.com/UA-Libraries-Research-Data-Services/UALIB_ScholarlyAPI_Cookbook # Online location of your book
# path_to_book: # Optional path to your book, relative to the repository root
path_to_book: src/ # Optional path to your book, relative to the repository root
branch: main # Which branch of the repository should be used when creating links (optional)

# Add GitHub buttons to your book
Expand All @@ -36,3 +39,9 @@ launch_buttons:
colab_url: ""
binderhub_url: ""
jupyterhub_url: ""

sphinx:
config:
templates_path:
- _templates
html_basepath: https://ua-libraries-research-data-services.github.io/UALIB_ScholarlyAPI_Cookbook/
73 changes: 73 additions & 0 deletions src/_templates/layout.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,73 @@
{% extends "!layout.html" %}

{%- block extrahead %}
{{ super() }}

<script type="application/ld+json">
{
"@context": "https://schema.org",
"@graph": [
{
"@type": "Organization",
"@id": "{{ html_baseurl }}#org-ua",
"name": "The University of Alabama",
"alternateName": ["UA"],
"url": "https://www.ua.edu/",
"sameAs": [
"https://en.wikipedia.org/wiki/University_of_Alabama"
]
"subOrganization": {
"@type": "Organization",
"@id": "{{ html_baseurl }}#org-ua-libraries",
"name": "The University of Alabama Libraries",
"alternateName": [
"UA Libraries",
"UALIB",
"University of Alabama Libraries",
"University Libraries"
],
"url": "https://www.lib.ua.edu/",
"subOrganization": [
{
"@type": "Organization",
"@id": "{{ html_baseurl }}#org-rds",
"name": "Research Data Services",
"alternateName": ["RDS"],
"url": "https://guides.lib.ua.edu/rds/"
},
{
"@type": "Organization",
"@id": "{{ html_baseurl }}#org-rcs",
"name": "Research Computing Services",
"alternateName": ["RCS"],
"url": "https://guides.lib.ua.edu/RCS/"
}
]
}
},
{
"@type": "WebSite",
"@id": "{{ html_baseurl }}#website",
"name": "University of Alabama Libraries Scholarly API Cookbook",
"url": "{{ html_baseurl }}",
"publisher": {
"@id": "{{ html_baseurl }}#org-ua-libraries"
},
"logo": {
"@type": "ImageObject",
"url": "{{ html_baseurl }}images/script-a-icon.png"
}
},
{
"@type": "WebPage",
"@id": {{ (html_baseurl ~ pathto(pagename, 1) ~ "#webpage") | tojson }},
"name": {{ title | striptags | tojson }},
"url": {{ (html_baseurl ~ pathto(pagename, 1)) | tojson }},
"isPartOf": { "@id": "{{html_baseurl}}#website" },
"publisher": { "@id": "{{html_baseurl}}#org-ua-libraries" }
}
]
}
</script>

{%- endblock %}
Loading
Loading