/readthedocs

sphinx rtd for .md and .rst template

Primary LanguageHTML

Readthedocs template

Prerequisites

Tested on the following

Dependencies Versions
Python ~3.6.2
pip ~18.0
virtualenv ~15.1.0

Getting started

  1. Install python ~ 3.6
  2. Create virtualenv 
    virtualenv --python=<$PATH_TO_PYTHON3.6>/bin/python <$PATH_TO_ENV>/readthedocs_env/
  3. Activate virtualenv 
    source <$PATH_TO_ENV>/readthedocs_env/bin/activate
  4. Install the dependencies 
    pip install requirements.tx
  5. Check links 
    make linkcheck
  6. Build the source 
    make html

Running the tests

Deployment

  1. Copy build folder to webserver root /var/www/html for Apache, /usr/share/nginx/html for Nginx

Built With

Contributing

Versioning

Readthedocs 1.0.0

Authors

  • Philip Sales - adopted work

License

This project is licensed under the Creative Commons- see the Types of Licenses

Acknowledgments