Configuration & Use

To use this template:

1. Download or git clone the f5-sphinx-theme

2. Copy contents of this repo to a new directory cp -Rf . /path/to/your/docs

3. cd /path/to/your/docs

4. Edit docs/conf.py

5. Modify the following lines:

   • classname = "Your Class Name"

   • github_repo = "https://github.com/f5devcentral/your-class-repo"

6. Build docs ./containthedocs-build.sh (see Build Scripts below)

7. Open the docs/_build/html/index.html file on you system in a web browser

8. Edit the *.rst files as needed for your class

9. Rebuild docs as needed using ./containthedocs-build.sh