Structuring a repo for docs#
Root level of the repo#
docs
directory : All source files for documentation go here.readthedocs.yml
: configuration file for readthedocs to build using conda
Inside the docs directory#
source
directory : contains all content source files in.rst
,.md
, or.ipynb
makefile
: used by Sphinx to build the docsenvironment.yml
: conda build instructions
Sphinx#
conf.py
: Sphinx configuration fileindex.rst
ofcontents.rst
: Sphinx master table of contents file_static
directory : contains images, drawings, icons_templates
directory: overrides theme templates and layoutsbuild
directory : html files generated by Sphinx (do not check this directory into GitHub)