jepler/sphinx-autoapi
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Format code samples on installation correctly

Browse source
This commit is contained in:
Andrew Chan 2018-02-14 14:50:54 -08:00 committed by GitHub
parent da611680df
commit e2e359eb69
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 4 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
README.rst
View file

@ -151,6 +151,7 @@ GO
Install go domain extension for sphinx.
.. code:: bash
pip install go sphinxcontrib_golangdomain
@ -161,11 +162,13 @@ Install a git client for your environment (e.g. from https://desktop.github.com/
Install our godocjson tool (preprocess godoc output to JSON, in a way similar to jsdoc -X).
.. code:: bash
go get github.com/rtfd/godocjson
Add go domain in your conf.py.
.. code:: python
extensions = [ 'sphinxcontrib.golangdomain',...
Before running building your doc, make sure the godocjson executable is in your path.
@ -180,6 +183,7 @@ Install nodejs on your platform.
Install jsdoc using npm.
.. code:: bash
npm install jsdoc -g
Before building your doc, make sure the jsdoc executable is in your path.