A minimal Sphinx documentation structure.
Features:
- Python 3
- Sphinx >= 1.6
docs: the root directory for documentation- intersphinx using Python 3
- supports markdown and restructured text
- rtd yml build file
- conda
environment.yml - pip
requirements_docs.txt
- Clone the repo from GitHub
git clone https://github.com/willingc/doc-basics.git- Change directory to
doc-basics.
cd doc-basics- Create and activate a virtual environment
python3 -m venv mydocenv
source mydocenv/bin/activate- Install requirements.
python3 -m pip install -r docs/requirements_docs.txtFrom the docs directory:
| Task | Command |
|---|---|
| Clean out prior doc builds | make clean |
| Build docs (in html format) | make html |
| Check links in docs | make linkcheck |
| View docs | open _build/html/index.html |