simple-doc-server

Tool for deploying a web server for hosting documentation See the documentation for more information.

Dependencies

See requirements.txt for python dependencies.

Installing dependencies inside system environment

pip install -r requirements.txt

Installing dependencies inside virtual environment

1. Creating a python virtual environment named venv

python3 -m venv venv

2. Activating the virtual environment

source venv/bin/activate

3. Installing dependencies

pip install -r requirements.txt

Accessing documentation

The documentation is hosted on Readthedocs - link

Building documentation locally

From the terminal

1. Clone the repository to your local machine.

2. Navigate to the docs/

3. Issue the command: make html

4. Open the index.html file in docs/build/ folder

See the following instructions for more information regarding updating documentation.

Contributing to documentation

Updating the documentation

1. Fork this repository from an upstream repository to your github account (An Upstream repository is the Parent/Original repository from where you forked your repository)

2. Edit the restructuredText (.rst) or markdown (.md) files in the docs/sources folder (editing of these files can performed directly using the file editing tools provided by github. This will allow you to commit your changes to the repository.

3. Make a pull request from your fork to the master branch of the Upstream repository.

4. Your changes will be reviewed and pulled into the Upstream repository.

Over time, your fork may become out of sync with the master branch of the Upstream repository. Create a pull request on your fork to pull in the latest changes from the master branch of the Upstream repository to get your fork back up-to-date. This can be performed directly on the github website.