Build Nuclei SDK Documentation¶
In Nuclei SDK, we use Sphinx and restructured text as documentation tool.
Here we only provide steps to build sphinx documentation in Linux environment.
To build this the documentation, you need to have these tools installed.
Python Pip tool
Then you can use the pip tool to install extra python packages required to build the documentation.
pip install -r doc/requirements.txt
Build The Documentation¶
Then you can build the documentation using the following command:
# cd to document folder cd doc # Build Sphinx documentation make html
The documentation will be generated in doc/build/html folder.
You can open the doc/build/html/index.html in your browser to view the details.