diff --git a/README.rst b/README.rst index c953900..b1d8d66 100644 --- a/README.rst +++ b/README.rst @@ -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.