From 7cca1a920f3ef444c6b5ed6d1072cad897f2b455 Mon Sep 17 00:00:00 2001 From: Casper da Costa-Luis Date: Thu, 17 Aug 2023 21:51:27 +0100 Subject: [PATCH] add references --- .github/workflows/pages.yml | 1 - README.md | 4 +++- _config.yml | 32 +++++++++++++++++--------------- references.bib | 9 +++++++++ 4 files changed, 29 insertions(+), 17 deletions(-) create mode 100644 references.bib diff --git a/.github/workflows/pages.yml b/.github/workflows/pages.yml index b8e2122..71cf36b 100644 --- a/.github/workflows/pages.yml +++ b/.github/workflows/pages.yml @@ -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} diff --git a/README.md b/README.md index 492c135..e877031 100644 --- a/README.md +++ b/README.md @@ -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}" ` -- glossary ref: {term}`GPU` +- glossary term: {term}`GPU` +- `references.bib` citation: {cite}`python` ## Table of Contents @@ -153,4 +154,5 @@ VRAM ### References ```{bibliography} +:style: unsrt ``` diff --git a/_config.yml b/_config.yml index 1c11ed0..1c3fe88 100644 --- a/_config.yml +++ b/_config.yml @@ -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 @@ -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) diff --git a/references.bib b/references.bib new file mode 100644 index 0000000..0a14211 --- /dev/null +++ b/references.bib @@ -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} +}