test-deploy

The dummy-docs project is used to test documentation tools for projects using the f5-sphinx-theme. It also uses the same scripts and tooling as the doc sets published on clouddocs.f5.com.

The Setup

Install the necessary software:

pip install -r requirements.txt

Choose one of the following methods for viewing the web site:

Local web directory

1. Change into a web directory:

   cd /var/www

2. Clone this repository:

   git clone https://github.com/kkinch/dummy-docs.git

3. Change to the dummy-docs directory:

   cd /var/www/dummy-docs

4. Generate the html:

   make html

5. The CSS files are in:

   /var/www/dummy-docs/docs/html/_static/css

Using GitPages

1. Clone this repository:

   git clone https://github.com/kkinch/dummy-docs.git

2. Set your github as remote repository:

   git remote set-url origin git@github.com:/.git git remote set-url origin https://github.com//repo>.git

3. Push to your github.

   git push

4. Log in to your repository.

5. Select settings

6. Scroll to GitHub Pages.

7. Select:

   master branch /docs folder:

8. Theme isn't necessary (empty .nojekyll file).

9. The page should be viewable at:

   https://.github.io/dummy-docs/

Directory structure overview

Raw files are essentially loaded into the custom_sphinx_theme sub-directories. When make html is executed, Sphinx generates content and places the new files in the html sub-directories.

tree -at /var/www/customsphinx

docs
├── conf.py
├── index.rst
├── index_reference_file.rst
├── _build
│       ├── doctree
│       └── html
│              ├── index.html
│              └── _static
│                      ├── css
│                      │      └── my_custom.css
│                      ├── js
│                      │      └── my_custom.js
│                      └── fonts
│                              └── custom_font
│
└── custom_sphinx_theme
        ├── theme.conf
        ├── layout.html
        ├── layout_include_file.html
        └── static
                ├── css
                │      └── my_custom.css
                ├── js
                │      └── my_custom.js
                └── fonts
                        └── custom_font