Skip to content

Commit

Permalink
docs: explain docs folder layout
Browse files Browse the repository at this point in the history
  • Loading branch information
casperdcl committed Jun 11, 2024
1 parent 5a99e80 commit 4dd2d0c
Showing 1 changed file with 21 additions and 0 deletions.
21 changes: 21 additions & 0 deletions docs/source/developer_guide.rst
Original file line number Diff line number Diff line change
Expand Up @@ -88,6 +88,27 @@ Rendered
Building documentation locally
------------------------------

Folder layout:

- `README.md` - rendered to `https://github.com/TomographicImaging/CIL`
- `docs/`
- `pages/` - landing (jekyll) source pages
- `_config.yml` - jekyll config file
- `_data/`
- `navigation.yml` - Header section
- `services.yml` - "Contact" footer section
- `network.yml` - "Thanks" footer section
- `XXX.md` - rendered to `https://tomographicimaging.github.io/CIL/XXX`
- `source/` - docs (sphinx) source pages
- `conf.py` - sphinx config file
- `XXX.rst` - rendered to `https://tomographicimaging.github.io/CIL/nightly/XXX`
- `docs_environment.yml` - sphinx dependencies
- `Gemfile*` - jekyll dependencies
- `Makefile` - common build scripts
- `mkdemos.py` - downloads demo notebooks to `source/demos/*.ipynb` & creates `source/demos.rst`
- `demos-template.rst`
- `mkversions.py` - creates `versions.json` used but sphinx docs version switcher

The easiest way to test documentation changes is to open a pull request and `download the rendered documentation from the CI <https://github.com/TomographicImaging/CIL/blob/master/.github/workflows/README.md>`_.

Alternatively, to build the docs locally, you will need a working ``cil`` installation.
Expand Down

0 comments on commit 4dd2d0c

Please sign in to comment.