NVIDIA-Genomics-Research / AtacWorks

Deep learning based processing of Atac-seq data
https://clara-parabricks.github.io/AtacWorks/
Other
128 stars 23 forks source link

Add sphinx docs #165

Closed ntadimeti closed 4 years ago

ntadimeti commented 4 years ago
ntadimeti commented 4 years ago

In order to add more pages to the webpage: run pip install requirements-base.txt to install sphinx dependencies 1) cd docs 2) Create a new md file inside docs/ dir 3) vi index.rst 4) Add your file name under:

   :maxdepth: 2

   readme
   pretrained_models
   tutorials/tutorial1
   tutorials/tutorial2
   Dockerfile
   <your file name wihtout the .md>

5) Build the html files using sphinx-build -b html ./ build

In order to view the html pages: 1) Clone the branch 2) cd docs/build 3)google-chrome index.html

ntadimeti commented 4 years ago

The above todo's will be done as new PRs -- collaborating with Avantika Lal on this.