Skip to content

Commit

Permalink
add references
Browse files Browse the repository at this point in the history
  • Loading branch information
casperdcl committed Aug 17, 2023
1 parent 1e5f6aa commit 7cca1a9
Show file tree
Hide file tree
Showing 4 changed files with 29 additions and 17 deletions.
1 change: 0 additions & 1 deletion .github/workflows/pages.yml
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,6 @@ jobs:
run: |
sed -ri 's#^(\s*baseurl:).*#\1 ${{ steps.pages.outputs.base_url }}#g' _config.yml
# https://jupyterbook.org/en/stable/reference/cli.html
touch references.bib # TODO: remove
jupyter-book build --warningiserror --nitpick .
- uses: actions/upload-pages-artifact@v2
with: {path: _build/html}
Expand Down
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,8 @@ This is a **figure caption** *in the margin*, vis https://jupyterbook.org/en/sta
- [inline ref](fig-ref)
- numbered ref: {numref}`fig-ref`
- custom ref: {numref}`Figure {number} with caption "{name}" <fig-ref>`
- glossary ref: {term}`GPU`
- glossary term: {term}`GPU`
- `references.bib` citation: {cite}`python`

## Table of Contents

Expand Down Expand Up @@ -153,4 +154,5 @@ VRAM
### References

```{bibliography}
:style: unsrt
```
32 changes: 17 additions & 15 deletions _config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,18 @@ repository:
url: https://github.com/premAI-io/state-of-open-source-ai
branch: main
only_build_toc_files: true
html:
baseurl: http://localhost:8000
favicon: assets/favicon.ico
use_edit_page_button: true
use_issues_button: true
use_repository_button: true
comments:
utterances:
issue-term: pathname
label: question
repo: premAI-io/state-of-open-source-ai
theme: preferred-color-scheme
parse:
myst_substitutions:
repo_url: https://github.com/premAI-io/state-of-open-source-ai
Expand All @@ -25,21 +37,11 @@ parse:
sphinx:
extra_extensions:
- sphinxemoji.sphinxemoji
html:
baseurl: http://localhost:8000
favicon: assets/favicon.ico
use_edit_page_button: true
use_issues_button: true
use_repository_button: true
comments:
utterances:
issue-term: pathname
label: question
repo: premAI-io/state-of-open-source-ai
theme: preferred-color-scheme
execute:
execute_notebooks: force # re-exec on each build (https://jupyterbook.org/content/execute.html)
config:
bibtex_reference_style: label
bibtex_bibfiles: [references.bib] # citations
latex: # for PDF builds
latex_documents:
targetname: book.tex
bibtex_bibfiles: [references.bib] # citations
execute:
execute_notebooks: force # re-exec on each build (https://jupyterbook.org/content/execute.html)
9 changes: 9 additions & 0 deletions references.bib
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
---
@manual{python,
title={{Python}: A dynamic, open source programming language},
author={Python Core Team},
organization={{Python Software Foundation (PSF)}},
year={2019},
url={https://www.python.org}
}

0 comments on commit 7cca1a9

Please sign in to comment.