You can build your website by adding md files in the docs/source directory, and by using high-level sections defined in this template as docs/source/subfolder/example.md and docs/source/subfolder/index.md.
To add a new sub-section, create a new markdown file in the appropriate section directory, and make sure to start it with a level-1 heading. Remember to also add the new file to the table of contents in the correspondingdocs/source/{section}/index.md file.
To add entries to an existing sub-section, simply add new level-2/3 headings to the right markdown file, as appropriate.
- Clone the GitHub repository, and create your
new_branch. - Edit the website and commit your changes to the
new_branch. - Push the
new_branchto GitHub and create a pull request. This will automatically trigger a GitHub Action that checks if the website still builds correctly. - If the checks pass, assign someone to review your changes.
- When the reviewer merges your changes into the
mainbranch, a different GitHub Action will be triggered, which will build the website and publish it to thegh-pagesbranch. - The updated website should be available at howto.neuroinformatics.dev
note If you wish to view the website locally, before you push it, you can do so by running the following commands from the root of the repository.
# First time only pip install -r docs/requirements.txt sphinx-build docs/source docs/build # Every time you want to build the website rm -rf docs/build && sphinx-build docs/source docs/buildYou can view the local build at
docs/build/index.html