How to Contribute
This website is build with the help of readthedocs.org and Sphinx
with sphinx_rtd_theme
You can read their documentation for details.
Installation
Clone the github repo
$ git clone https://github.com/Saikat248/anooplab-docs.git
and install this two packages
$ pip install sphinx
$ pip install sphinx_rtd_theme
Navigate to anooplab-docs/docs
directory
there is a Makefile
and start
$ make html
It will create a _build
directory and the html
files
$ firefox _build/html/index.html
The whole website will run locally. Go ahead start editing the documents and before pushing make sure the build is successful.
Enjoy !!