diff options
Diffstat (limited to 'docs/etc')
| -rw-r--r-- | docs/etc/conf.py | 8 | ||||
| -rw-r--r-- | docs/etc/requirements.txt | 1 |
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 |