summaryrefslogtreecommitdiffstats
path: root/docs/how-to-use-docs/documentation-example.rst
diff options
context:
space:
mode:
authorRyota MIBU <r-mibu@cq.jp.nec.com>2015-12-07 20:51:42 +0900
committerFatih Degirmenci <fatih.degirmenci@ericsson.com>2015-12-10 10:37:49 +0000
commit7f61502374b4e2f54e1861ba3eaa1dc7f53b4416 (patch)
tree8b972c4db818a06df4163fc774f6a94f90a2b08a /docs/how-to-use-docs/documentation-example.rst
parent60fba6365bd69e1bb59c7f0298e0f4a6757bf580 (diff)
docs: add process to request new sphinx extension(s)
http://lists.opnfv.org/pipermail/opnfv-tech-discuss/2015-December/006901.html Change-Id: I3a2691bd1d69b5c8c250aaec34e4b76e28e7df73 Signed-off-by: Ryota MIBU <r-mibu@cq.jp.nec.com> Co-Authored-By: Ildiko Vancsa <ildiko.vancsa@ericsson.com>
Diffstat (limited to 'docs/how-to-use-docs/documentation-example.rst')
-rw-r--r--docs/how-to-use-docs/documentation-example.rst19
1 files changed, 17 insertions, 2 deletions
diff --git a/docs/how-to-use-docs/documentation-example.rst b/docs/how-to-use-docs/documentation-example.rst
index 5fc2b1420..628162b79 100644
--- a/docs/how-to-use-docs/documentation-example.rst
+++ b/docs/how-to-use-docs/documentation-example.rst
@@ -87,9 +87,9 @@ If you need to change the default configuration for document build, create
new conf.py in the document directory (e.g. 'docs/how-to-use-docs/conf.py')
that will be used in build process instead of default for OPNFV document
build. The OPNFV default configuration can be found in releng repo
-(see `conf.py`_).
+(see `docs/etc/conf.py`_).
-.. _conf.py:
+.. _docs/etc/conf.py:
https://gerrit.opnfv.org/gerrit/gitweb?p=releng.git;a=blob;f=docs/etc/conf.py;
In the build process, the following parameters are automatically added if they
@@ -170,3 +170,18 @@ change. Then, the merge job will upload latest build documents to
``http://artifacts.opnfv.org/<Project Name>/docs/`` .
You can put links in your project wiki page, so that everyone can see the
latest document always.
+
+Sphinx Extensions
+=================
+
+You can see available sphinx extension(s) in `docs/etc/requirements.txt`_.
+
+.. _docs/etc/requirements.txt:
+ https://gerrit.opnfv.org/gerrit/gitweb?p=releng.git;a=blob;f=docs/etc/requirements.txt;
+
+You can use other sphinx extensions to improve your documents.
+To share such tips, we encourage you to enable the extension in OPNFV infra
+by asking releng and opnfvdocs teams to add new sphinx extension via gerrit
+(proposing change in `docs/etc/conf.py`_ and `docs/etc/requirements.txt`_).
+After quick sanity checks, we'll install python package (if needed) and make
+it available in OPNFV document build.