mirror of
https://github.com/getpelican/pelican.git
synced 2025-10-15 20:28:56 +02:00
Added new sphinxtheme as requirement for docs Modified docs conf to support the theme update
This commit is contained in:
parent
5b4381c19c
commit
4cae9ea88f
2 changed files with 28 additions and 9 deletions
|
|
@ -9,3 +9,6 @@ typogrify
|
||||||
|
|
||||||
# To perform release
|
# To perform release
|
||||||
bumpr==0.2.0
|
bumpr==0.2.0
|
||||||
|
|
||||||
|
# For docs theme
|
||||||
|
sphinx_rtd_theme
|
||||||
|
|
|
||||||
34
docs/conf.py
34
docs/conf.py
|
|
@ -2,6 +2,8 @@
|
||||||
from __future__ import unicode_literals
|
from __future__ import unicode_literals
|
||||||
import sys, os
|
import sys, os
|
||||||
|
|
||||||
|
on_rtd = os.environ.get('READTHEDOCS', None) == 'True'
|
||||||
|
|
||||||
sys.path.append(os.path.abspath(os.pardir))
|
sys.path.append(os.path.abspath(os.pardir))
|
||||||
|
|
||||||
from pelican import __version__
|
from pelican import __version__
|
||||||
|
|
@ -21,29 +23,43 @@ rst_prolog = '''
|
||||||
.. |last_stable| replace:: :pelican-doc:`{0}`
|
.. |last_stable| replace:: :pelican-doc:`{0}`
|
||||||
'''.format(last_stable)
|
'''.format(last_stable)
|
||||||
|
|
||||||
|
# The name of the Pygments (syntax highlighting) style to use.
|
||||||
|
pygments_style = 'sphinx'
|
||||||
|
|
||||||
extlinks = {
|
extlinks = {
|
||||||
'pelican-doc': ('http://docs.getpelican.com/%s/', '')
|
'pelican-doc': ('http://docs.getpelican.com/%s/', '')
|
||||||
}
|
}
|
||||||
|
|
||||||
# -- Options for HTML output ---------------------------------------------------
|
# -- Options for HTML output ---------------------------------------------------
|
||||||
|
|
||||||
html_theme_path = ['_themes']
|
html_theme = 'default'
|
||||||
html_theme = 'pelican'
|
if not on_rtd:
|
||||||
|
try:
|
||||||
html_theme_options = {
|
import sphinx_rtd_theme
|
||||||
'nosidebar': True,
|
html_theme = 'sphinx_rtd_theme'
|
||||||
'index_logo': 'pelican.png',
|
html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
|
||||||
'github_fork': 'getpelican/pelican',
|
except ImportError:
|
||||||
}
|
pass
|
||||||
|
|
||||||
html_static_path = ['_static']
|
html_static_path = ['_static']
|
||||||
|
|
||||||
# Output file base name for HTML help builder.
|
# Output file base name for HTML help builder.
|
||||||
htmlhelp_basename = 'Pelicandoc'
|
htmlhelp_basename = 'Pelicandoc'
|
||||||
|
|
||||||
|
html_use_smartypants = True
|
||||||
|
|
||||||
|
# If false, no module index is generated.
|
||||||
|
html_use_modindex = False
|
||||||
|
|
||||||
|
# If false, no index is generated.
|
||||||
|
html_use_index = False
|
||||||
|
|
||||||
|
# If true, links to the reST sources are added to the pages.
|
||||||
|
html_show_sourcelink = False
|
||||||
|
|
||||||
# -- Options for LaTeX output --------------------------------------------------
|
# -- Options for LaTeX output --------------------------------------------------
|
||||||
latex_documents = [
|
latex_documents = [
|
||||||
('index', 'Pelican.tex', 'Pelican Documentation',
|
('index', 'Pelican.tex', 'Pelican Documentation',
|
||||||
'Alexis Métaireau', 'manual'),
|
'Alexis Métaireau', 'manual'),
|
||||||
]
|
]
|
||||||
|
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue