Docs: switch to openstackdocstheme

Project documents are being reprocessed due to document migration[1].
Update the docs theme to openstackdocstheme instead of oslosphinx.

[1] https://review.openstack.org/#/c/472275/

Change-Id: I9353ba579b093d0ab91e2f60612b8cbc8ffbb733
Co-Authored-By: chenxing <chen.xing@99cloud.net>
This commit is contained in:
Hanxi Liu 2017-06-23 11:10:54 +08:00
parent 17124613ec
commit b9945c2b1f
3 changed files with 16 additions and 22 deletions

View File

@ -14,7 +14,6 @@
import subprocess
import sys
import os
import warnings
BASE_DIR = os.path.dirname(os.path.abspath(__file__))
ROOT = os.path.abspath(os.path.join(BASE_DIR, "..", ".."))
@ -40,12 +39,11 @@ os.environ['DJANGO_SETTINGS_MODULE'] = 'openstack_dashboard.settings'
# or your custom ones.
extensions = [
'sphinx.ext.autodoc',
'sphinxcontrib.autohttp.flask',
'wsmeext.sphinxext',
'sphinx.ext.coverage',
'sphinx.ext.viewcode',
'sphinxcontrib.pecanwsme.rest',
'oslosphinx',
'openstackdocstheme',
]
wsme_protocols = ['restjson', 'restxml']
@ -67,7 +65,10 @@ source_suffix = '.rst'
# The master toctree document.
master_doc = 'index'
# General information about the project.
# openstackdocstheme options
repository_name = 'openstack/panko'
bug_project = 'panko'
bug_tag = ''
project = u'Panko'
copyright = u'2012-2015, OpenStack Foundation'
@ -116,6 +117,7 @@ nitpicky = False
# a list of builtin themes.
# html_theme_path = ['.']
# html_theme = '_theme'
html_theme = 'openstackdocs'
# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the
@ -150,15 +152,7 @@ html_theme_options = {
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
# using the given strftime format.
#html_last_updated_fmt = '%b %d, %Y'
try:
git_cmd = ["git", "log", "--pretty=format:'%ad, commit %h'", "--date=local",
"-n1"]
html_last_updated_fmt = subprocess.check_output(git_cmd).decode('utf-8')
except Exception:
warnings.warn('Cannot get last updated time from git repository. '
'Not setting "html_last_updated_fmt".')
html_last_updated_fmt = '%Y-%m-%d %H:%M'
# If true, SmartyPants will be used to convert quotes and dashes to
# typographically correct entities.

View File

@ -12,9 +12,6 @@
# See the License for the specific language governing permissions and
# limitations under the License.
# Panko Release Notes documentation build configuration file, created by
# sphinx-quickstart on Tue Nov 3 17:40:50 2015.
#
# This file is execfile()d with the current directory set to its
# containing dir.
#
@ -38,8 +35,8 @@
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = [
'oslosphinx',
'reno.sphinxext',
'openstackdocstheme',
]
# Add any paths that contain templates here, relative to this directory.
@ -54,7 +51,10 @@ source_suffix = '.rst'
# The master toctree document.
master_doc = 'index'
# General information about the project.
# openstackdocstheme options
repository_name = 'openstack/panko'
bug_project = 'panko'
bug_tag = ''
project = u'Panko Release Notes'
copyright = u'2015, Panko Developers'
@ -112,7 +112,7 @@ pygments_style = 'sphinx'
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
html_theme = 'default'
html_theme = 'openstackdocs'
# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the
@ -150,7 +150,7 @@ html_static_path = ['_static']
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
# using the given strftime format.
# html_last_updated_fmt = '%b %d, %Y'
html_last_updated_fmt = '%Y-%m-%d %H:%M'
# If true, SmartyPants will be used to convert quotes and dashes to
# typographically correct entities.

View File

@ -9,12 +9,12 @@ happybase!=0.7,>=0.5,<1.0.0;python_version=='2.7' # MIT
mock>=1.2 # BSD
PyMySQL>=0.6.2 # MIT License
# Docs Requirements
oslosphinx!=3.4.0,>=2.5.0 # Apache-2.0
oslotest>=1.10.0 # Apache-2.0
psycopg2>=2.5 # LGPL/ZPL
pymongo!=3.1,>=3.0.2 # Apache-2.0
python-subunit>=0.0.18 # Apache-2.0/BSD
sphinx!=1.2.0,!=1.3b1,<1.3,>=1.1.2 # BSD
sphinx>=1.6.2 # BSD
openstackdocstheme>=1.11.0 # Apache-2.0
sphinxcontrib-httpdomain # BSD
sphinxcontrib-pecanwsme>=0.8 # Apache-2.0
testrepository>=0.0.18 # Apache-2.0/BSD