summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJenkins <jenkins@review.openstack.org>2017-06-17 10:10:30 +0000
committerGerrit Code Review <review@openstack.org>2017-06-17 10:10:30 +0000
commitf89a2467d837dc3c94cba0dcfdf5c142aa0c94b9 (patch)
treed5d3fae306e9faef3e15366d6e23fe42539ba075
parent2cdb1fc1fd54f8472370087de3b755fd8d87dd82 (diff)
parent2a1b0b05234048fe0f29df459b984b87faea7505 (diff)
Merge "docs: switch to openstackdocstheme"
-rw-r--r--doc/source/conf.py19
-rw-r--r--doc/source/dashboards/index.rst7
-rw-r--r--doc/source/index.rst12
-rw-r--r--test-requirements.txt1
4 files changed, 27 insertions, 12 deletions
diff --git a/doc/source/conf.py b/doc/source/conf.py
index 52b645d..c3c7d0d 100644
--- a/doc/source/conf.py
+++ b/doc/source/conf.py
@@ -31,6 +31,8 @@ import subprocess
31import sys 31import sys
32import warnings 32import warnings
33 33
34import openstackdocstheme
35
34# If extensions (or modules to document with autodoc) are in another directory, 36# If extensions (or modules to document with autodoc) are in another directory,
35# add these directories to sys.path here. If the directory is relative to the 37# add these directories to sys.path here. If the directory is relative to the
36# documentation root, use os.path.abspath to make it absolute, like shown here. 38# documentation root, use os.path.abspath to make it absolute, like shown here.
@@ -48,7 +50,6 @@ extensions = ['sphinx.ext.autodoc',
48 'sphinx.ext.ifconfig', 50 'sphinx.ext.ifconfig',
49 'sphinx.ext.graphviz', 51 'sphinx.ext.graphviz',
50 'sphinx.ext.todo', 52 'sphinx.ext.todo',
51 'oslosphinx',
52 'support_matrix'] 53 'support_matrix']
53 54
54todo_include_todos = True 55todo_include_todos = True
@@ -126,6 +127,7 @@ modindex_common_prefix = ['neutron.']
126# Sphinx are currently 'default' and 'sphinxdoc'. 127# Sphinx are currently 'default' and 'sphinxdoc'.
127# html_theme_path = ["."] 128# html_theme_path = ["."]
128# html_theme = '_theme' 129# html_theme = '_theme'
130html_theme = 'openstackdocs'
129 131
130# Theme options are theme-specific and customize the look and feel of a theme 132# Theme options are theme-specific and customize the look and feel of a theme
131# further. For a list of options available for each theme, see the 133# further. For a list of options available for each theme, see the
@@ -134,6 +136,7 @@ modindex_common_prefix = ['neutron.']
134 136
135# Add any paths that contain custom themes here, relative to this directory. 137# Add any paths that contain custom themes here, relative to this directory.
136#html_theme_path = ['_theme'] 138#html_theme_path = ['_theme']
139html_theme_path = [openstackdocstheme.get_html_theme_path()]
137 140
138# The name for this set of Sphinx documents. If None, it defaults to 141# The name for this set of Sphinx documents. If None, it defaults to
139# "<project> v<release> documentation". 142# "<project> v<release> documentation".
@@ -159,14 +162,22 @@ html_static_path = ['_static']
159# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, 162# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
160# using the given strftime format. 163# using the given strftime format.
161#html_last_updated_fmt = '%b %d, %Y' 164#html_last_updated_fmt = '%b %d, %Y'
162git_cmd = ["git", "log", "--pretty=format:'%ad, commit %h'", "--date=local -", 165git_cmd = "git log --pretty=format:'%ad, commit %h' --date=local -n1"
163 "n1"]
164try: 166try:
165 html_last_updated_fmt = subprocess.check_output(git_cmd).decode('utf-8') 167 html_last_updated_fmt = os.popen(git_cmd).read()
166except Exception: 168except Exception:
167 warnings.warn('Cannot get last updated time from git repository. ' 169 warnings.warn('Cannot get last updated time from git repository. '
168 'Not setting "html_last_updated_fmt".') 170 'Not setting "html_last_updated_fmt".')
169 171
172gitsha = os.popen("/usr/bin/git rev-parse HEAD").read()
173giturl = u'https://git.openstack.org/cgit/openstack/neutron/tree/doc/source'
174# html_context allows us to pass arbitrary values into the html template
175html_context = {
176 "gitsha": gitsha,
177 "giturl": giturl,
178 "bug_project": "neutron",
179 "bug_tag": "doc",
180 }
170 181
171# If true, SmartyPants will be used to convert quotes and dashes to 182# If true, SmartyPants will be used to convert quotes and dashes to
172# typographically correct entities. 183# typographically correct entities.
diff --git a/doc/source/dashboards/index.rst b/doc/source/dashboards/index.rst
index 1202a03..a3bc33f 100644
--- a/doc/source/dashboards/index.rst
+++ b/doc/source/dashboards/index.rst
@@ -1,5 +1,8 @@
1CI Status Dashboards
2====================
3
1Gerrit Dashboards 4Gerrit Dashboards
2================= 5-----------------
3 6
4- `Neutron master branch reviews <https://review.openstack.org/#/dashboard/?foreach=%28project%3Aopenstack%2Fneutron+OR+project%3Aopenstack%2Fpython%252Dneutronclient%29+status%3Aopen+NOT+owner%3Aself+NOT+label%3AWorkflow%3C%3D%252D1+label%3AVerified%3E%3D1%252cjenkins+NOT+label%3ACode%252DReview%3E%3D%252D2%252cself+branch%3Amaster&title=Neutron+Review+Inbox+%28master+branch+only%29&Needs+Feedback+%28Changes+older+than+5+days+that+have+not+been+reviewed+by+anyone%29=NOT+label%3ACode%252DReview%3C%3D2+age%3A5d&You+are+a+reviewer%252c+but+haven%27t+voted+in+the+current+revision=reviewer%3Aself&Needs+final+%2B2=label%3ACode%252DReview%3E%3D2+NOT%28reviewerin%3Aneutron%252Dcore+label%3ACode%252DReview%3C%3D%252D1%29+limit%3A50&Passed+Jenkins%252c+No+Negative+Core+Feedback=NOT+label%3ACode%252DReview%3E%3D2+NOT%28reviewerin%3Aneutron%252Dcore+label%3ACode%252DReview%3C%3D%252D1%29+limit%3A50&Wayward+Changes+%28Changes+with+no+code+review+in+the+last+2days%29=NOT+label%3ACode%252DReview%3C%3D2+age%3A2d>`_ 7- `Neutron master branch reviews <https://review.openstack.org/#/dashboard/?foreach=%28project%3Aopenstack%2Fneutron+OR+project%3Aopenstack%2Fpython%252Dneutronclient%29+status%3Aopen+NOT+owner%3Aself+NOT+label%3AWorkflow%3C%3D%252D1+label%3AVerified%3E%3D1%252cjenkins+NOT+label%3ACode%252DReview%3E%3D%252D2%252cself+branch%3Amaster&title=Neutron+Review+Inbox+%28master+branch+only%29&Needs+Feedback+%28Changes+older+than+5+days+that+have+not+been+reviewed+by+anyone%29=NOT+label%3ACode%252DReview%3C%3D2+age%3A5d&You+are+a+reviewer%252c+but+haven%27t+voted+in+the+current+revision=reviewer%3Aself&Needs+final+%2B2=label%3ACode%252DReview%3E%3D2+NOT%28reviewerin%3Aneutron%252Dcore+label%3ACode%252DReview%3C%3D%252D1%29+limit%3A50&Passed+Jenkins%252c+No+Negative+Core+Feedback=NOT+label%3ACode%252DReview%3E%3D2+NOT%28reviewerin%3Aneutron%252Dcore+label%3ACode%252DReview%3C%3D%252D1%29+limit%3A50&Wayward+Changes+%28Changes+with+no+code+review+in+the+last+2days%29=NOT+label%3ACode%252DReview%3C%3D2+age%3A2d>`_
5- `Neutron subproject reviews (master branch) <https://review.openstack.org/#/dashboard/?foreach=%28project%3Aopenstack%2Fdragonflow+OR+project%3Aopenstack%2Fnetworking%252Darista+OR+project%3Aopenstack%2Fnetworking%252Dbagpipe%252Dl2+OR+project%3Aopenstack%2Fnetworking%252Dbgpvpn+OR+project%3Aopenstack%2Fnetworking%252Dcisco+OR+project%3Aopenstack%2Fnetworking%252Dl2gw+OR+project%3Aopenstack%2Fnetworking%252Dlenovo+OR+project%3Aopenstack%2Fnetworking%252Dmidonet+OR+project%3Aopenstack%2Fnetworking%252Dodl+OR+project%3Aopenstack%2Fnetworking%252Dofagent+OR+project%3Aopenstack%2Fnetworking%252Donos+OR+project%3Aopenstack%2Fnetworking%252Dovn+OR+project%3Aopenstack%2Fnetworking%252Dsfc+OR+project%3Aopenstack%2Foctavia+OR+project%3Aopenstack%2Fnetworking%252Dplumgrid+OR+project%3Aopenstack%2Fvmware%252Dnsx+OR+project%3Aopenstack%2Fnetworking%252Dvsphere%29+status%3Aopen+NOT+owner%3Aself+NOT+label%3AWorkflow%3C%3D%252D1+label%3AVerified%3E%3D1%252cjenkins+NOT+label%3ACode%252DReview%3E%3D%252D2%252cself+branch%3Amaster&title=Neutron+Sub+Projects+Review+Inbox&Needs+Feedback+%28Changes+older+than+5+days+that+have+not+been+reviewed+by+anyone%29=NOT+label%3ACode%252DReview%3C%3D2+age%3A5d&You+are+a+reviewer%252c+but+haven%27t+voted+in+the+current+revision=reviewer%3Aself&Needs+final+%2B2=label%3ACode%252DReview%3E%3D2+NOT%28reviewerin%3Aneutron%252Dcore+label%3ACode%252DReview%3C%3D%252D1%29+limit%3A50&Passed+Jenkins%252c+No+Negative+Core+Feedback=NOT+label%3ACode%252DReview%3E%3D2+NOT%28reviewerin%3Aneutron%252Dcore+label%3ACode%252DReview%3C%3D%252D1%29+limit%3A50&Wayward+Changes+%28Changes+with+no+code+review+in+the+last+2days%29=NOT+label%3ACode%252DReview%3C%3D2+age%3A2d>`_ 8- `Neutron subproject reviews (master branch) <https://review.openstack.org/#/dashboard/?foreach=%28project%3Aopenstack%2Fdragonflow+OR+project%3Aopenstack%2Fnetworking%252Darista+OR+project%3Aopenstack%2Fnetworking%252Dbagpipe%252Dl2+OR+project%3Aopenstack%2Fnetworking%252Dbgpvpn+OR+project%3Aopenstack%2Fnetworking%252Dcisco+OR+project%3Aopenstack%2Fnetworking%252Dl2gw+OR+project%3Aopenstack%2Fnetworking%252Dlenovo+OR+project%3Aopenstack%2Fnetworking%252Dmidonet+OR+project%3Aopenstack%2Fnetworking%252Dodl+OR+project%3Aopenstack%2Fnetworking%252Dofagent+OR+project%3Aopenstack%2Fnetworking%252Donos+OR+project%3Aopenstack%2Fnetworking%252Dovn+OR+project%3Aopenstack%2Fnetworking%252Dsfc+OR+project%3Aopenstack%2Foctavia+OR+project%3Aopenstack%2Fnetworking%252Dplumgrid+OR+project%3Aopenstack%2Fvmware%252Dnsx+OR+project%3Aopenstack%2Fnetworking%252Dvsphere%29+status%3Aopen+NOT+owner%3Aself+NOT+label%3AWorkflow%3C%3D%252D1+label%3AVerified%3E%3D1%252cjenkins+NOT+label%3ACode%252DReview%3E%3D%252D2%252cself+branch%3Amaster&title=Neutron+Sub+Projects+Review+Inbox&Needs+Feedback+%28Changes+older+than+5+days+that+have+not+been+reviewed+by+anyone%29=NOT+label%3ACode%252DReview%3C%3D2+age%3A5d&You+are+a+reviewer%252c+but+haven%27t+voted+in+the+current+revision=reviewer%3Aself&Needs+final+%2B2=label%3ACode%252DReview%3E%3D2+NOT%28reviewerin%3Aneutron%252Dcore+label%3ACode%252DReview%3C%3D%252D1%29+limit%3A50&Passed+Jenkins%252c+No+Negative+Core+Feedback=NOT+label%3ACode%252DReview%3E%3D2+NOT%28reviewerin%3Aneutron%252Dcore+label%3ACode%252DReview%3C%3D%252D1%29+limit%3A50&Wayward+Changes+%28Changes+with+no+code+review+in+the+last+2days%29=NOT+label%3ACode%252DReview%3C%3D2+age%3A2d>`_
@@ -12,7 +15,7 @@ Useful dashboard definitions are found in ``dashboards`` directory.
12.. _Gerrit Dashboard Creator: https://github.com/openstack/gerrit-dash-creator 15.. _Gerrit Dashboard Creator: https://github.com/openstack/gerrit-dash-creator
13 16
14Grafana Dashboards 17Grafana Dashboards
15================== 18------------------
16 19
17Look for neutron and networking-* dashboard by names by going to the following link: 20Look for neutron and networking-* dashboard by names by going to the following link:
18 21
diff --git a/doc/source/index.rst b/doc/source/index.rst
index 0a24385..f5805c6 100644
--- a/doc/source/index.rst
+++ b/doc/source/index.rst
@@ -40,7 +40,7 @@ The `Neutron Development wiki`_ is also a good resource for new contributors.
40Enjoy! 40Enjoy!
41 41
42Neutron Policies 42Neutron Policies
43================ 43----------------
44 44
45.. toctree:: 45.. toctree::
46 :maxdepth: 2 46 :maxdepth: 2
@@ -48,7 +48,7 @@ Neutron Policies
48 policies/index 48 policies/index
49 49
50Neutron Stadium 50Neutron Stadium
51=============== 51----------------
52 52
53.. toctree:: 53.. toctree::
54 :maxdepth: 2 54 :maxdepth: 2
@@ -56,7 +56,7 @@ Neutron Stadium
56 stadium/index 56 stadium/index
57 57
58Neutron Feature Classification 58Neutron Feature Classification
59============================== 59------------------------------
60 60
61.. toctree:: 61.. toctree::
62 :maxdepth: 3 62 :maxdepth: 3
@@ -64,7 +64,7 @@ Neutron Feature Classification
64 feature_classification/index 64 feature_classification/index
65 65
66Developer Docs 66Developer Docs
67============== 67--------------
68 68
69.. toctree:: 69.. toctree::
70 :maxdepth: 3 70 :maxdepth: 3
@@ -72,7 +72,7 @@ Developer Docs
72 devref/index 72 devref/index
73 73
74Dashboards 74Dashboards
75========== 75----------
76 76
77There is a collection of dashboards to help developers and reviewers 77There is a collection of dashboards to help developers and reviewers
78located here. 78located here.
@@ -83,6 +83,6 @@ located here.
83 dashboards/index 83 dashboards/index
84 84
85API Extensions 85API Extensions
86============== 86--------------
87 87
88Go to http://api.openstack.org for information about OpenStack Network API extensions. 88Go to http://api.openstack.org for information about OpenStack Network API extensions.
diff --git a/test-requirements.txt b/test-requirements.txt
index f9c92cc..1419ab9 100644
--- a/test-requirements.txt
+++ b/test-requirements.txt
@@ -8,6 +8,7 @@ fixtures>=3.0.0 # Apache-2.0/BSD
8mock>=2.0 # BSD 8mock>=2.0 # BSD
9python-subunit>=0.0.18 # Apache-2.0/BSD 9python-subunit>=0.0.18 # Apache-2.0/BSD
10sphinx!=1.6.1,>=1.5.1 # BSD 10sphinx!=1.6.1,>=1.5.1 # BSD
11openstackdocstheme>=1.5.0 # Apache-2.0
11oslosphinx>=4.7.0 # Apache-2.0 12oslosphinx>=4.7.0 # Apache-2.0
12testrepository>=0.0.18 # Apache-2.0/BSD 13testrepository>=0.0.18 # Apache-2.0/BSD
13testtools>=1.4.0 # MIT 14testtools>=1.4.0 # MIT