Skip to content
This repository has been archived by the owner on Apr 28, 2023. It is now read-only.

Latest commit

 

History

History

docs

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 
 
 
 
 

Generating Sphinx documentation for Tensor Comprehensions

  1. First install sphinx
pip install Sphinx
  1. We use mobile friendly sphinx_rtd_theme style theme available here https://github.com/rtfd/sphinx_rtd_theme. Run the command below:
cd docs && pip install -r requirements.txt
  1. Edit the document under docs/source/. If you are adding a new doc, make sure to modify toctree in source/index.rst. For syntax about .rst, this link might be helpful http://www.sphinx-doc.org/en/stable/rest.html. If you have written markdown before, it should be easy to write .rst files as well.

TIP: All the sphinx based documentations have a link View Page Source on top right. You can click that link to see the corresponding .rst file for that page.

  1. Run
cd docs && make html
  1. Now you can see the generated html index.html under build/html/

  2. Send PR

Generating Doxygen docs for Tensor Comprehensions

  1. Install Doxygen

Run the command

$ apt-get install doxygen
  1. Edit the docs/doxygen/index.md file for making changes to the main page for doxygen docs.

  2. Edit the docs/doxygen/Doxyfile file for making change to what code should be documented, excluded etc.

  3. Now, test the docs locally. Run the following commands:

$ cd $HOME/TensorComprehensions && mkdir -p $HOME/TensorComprehensions-docs/api
$ doxygen docs/doxygen/Doxyfile

This will generate an html folder which will contain all the html files for the documentation. Please DO NOT edit the html folder manually. Rather make changes as suggested in Step 2, 3 and re-generate docs.

  1. Check the HTML docs look fine to you.

  2. Send a PR