jpforcioli / github_howto_jsonrpc_api

How to get the HTML version of this?

• How to get the HTML version of this?
  • Linux with python3
    • Clone the git project
    • Install sphinx
    • To generate the HTML documentation
    • To read the HTML documentation
  • Readthedoc

Linux with python3

Clone the git project

git clone https://git.fndn.fortinet.net/fortimanager/howto_jsonrpc_api.git

Install sphinx

cd howto_jsonrpc_api
mkdir -p _build
python3 -m venv .venv
source .venv/bin/activate
python3 -m pip install pip --upgrade
python3 -m pip install sphinx
python3 -m pip install sphinx_tabs
python3 -m pip install sphinx_toolbox
python3 -m pip install sphinxcontrib.images
python3 -m pip install sphinx_copybutton
python3 -m pip install sphinx_design
# Ignore the possible error produce by the above command
python3 -m pip install sphinx_book_theme

To generate the HTML documentation

make html

To read the HTML documentation

Now you can open file:

_build/html/index.html

with your browser.

Readthedoc

cp -rv *rst Makefile make.bat README.md datas _images _static conf.py images index.rst .readthedocs.yaml requirements.txt ../github_howto_jsonrpc_api/