Skip to content

Updating the documentation

Andrew Ang edited this page Aug 1, 2018 · 5 revisions

The documentation website at https://harvard-vpal.github.io/gdocrevisions/docs is built from the /docs/ folder using Sphinx.

Steps to update documentation:

Make edits as needed to files in /docs/_source:

  • conf.py (e.g. version/release)
  • gdocrevisions.rst, index.rst for doc tree structure

Ensure Sphinx is installed (pip install sphinx)

Build docs:

# change to /docs/ directory
cd docs

# build docs
make .

Lazy version from repo root: pushd docs; make .; popd

Preview changes in generated html (/docs/docs/index.html)

Clone this wiki locally