summaryrefslogtreecommitdiffstats
path: root/docs/etc
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/etc
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/etc')
-rw-r--r--docs/etc/conf.py8
-rw-r--r--docs/etc/requirements.txt1
2 files changed, 8 insertions, 1 deletions
diff --git a/docs/etc/conf.py b/docs/etc/conf.py
index 06ae7be01..d10868de5 100644
--- a/docs/etc/conf.py
+++ b/docs/etc/conf.py
@@ -6,7 +6,13 @@ directory (e.g. docs/how-to-use-docs/conf.py). If there is no 'conf.py'
in the document directory, this file will be copied to that directory
before the document builder jobs ('opnfv-docs-verify' and 'opnfv-docs-merge').
-See https://wiki.opnfv.org/documentation/tools .
+You may need python package installation for new sphinx extension.
+Install python package with 'pip' in your machine and add the extension to
+the 'extensions' list below to test the documentation build locally.
+If you feel that your extensions would be useful for other projects too,
+we encourage you to propose a change in the releng repository.
+
+For further guidance see the https://wiki.opnfv.org/documentation/tools page.
'''
extensions = ['sphinxcontrib.httpdomain']
diff --git a/docs/etc/requirements.txt b/docs/etc/requirements.txt
new file mode 100644
index 000000000..4df3b687d
--- /dev/null
+++ b/docs/etc/requirements.txt
@@ -0,0 +1 @@
+sphinxcontrib-httpdomain