A collection of outputs from the projects created at the DISC Unconference 2023.
If you find typos, incomplete or misleading instructions, or have suggestions for improvements to this template, open an issue at the numfocus/disc-unconference-2023-projects repo.
This repository sets up a JupyterBook. All content is markdown files stored in the unconference
folder.
To add a new project page:
- Add your markdown file to the
unconference
folder; - Add the name of your markdown file to the
_toc.yml
file, under thechapters
heading. - Submit a pull request to this repo. Make sure to add your collaborators as co-authors on the pull request. Refer to the GitHub documentation for guidance on how to do it.
To build the book locally, you need to have JupyterBook installed. You can use either pip
or conda
to install this and other requirements for your book by running
pip install -r requirements.txt
or
conda env create -f environment.yml
conda activate project
Then, run
sphinx-build unconference unconference/_build/html -b html
to build the book. You can then open the generated unconference/_build/html/index.html
file in your browser to view the book. You can use python -m webbrowser unconference/_build/html/index.html
to open the website directly on your default browser.
By default, the English version is generated. In order to build a different language
(provided translations are already available), set the WEBSITE_LANGUAGE
env variable
to the language code you want to use, e.g. es
.
This repository comes with a pre-defined GitHub pages setup.
You can then access this site at https://numfocus.github.io/disc-unconference-2023-projects/
.
Translatable sources can be generated as .pot
files with:
sphinx-build unconference unconference/_build/gettext -b gettext
.po
files can then be generated with sphinx-intl:
sphinx-intl update -p unconference/_build/gettext -l es
.po
files should be committed to the repo. .pot
files should not, they should be generated when
needed with gettext
as shown above. -l
flag is what indicates what languages should be
created/updated.
The content can then be translated: locally with poedit or via transifex/crowdin?