Skip to content
GitLab
Projects
Groups
Snippets
Help
Loading...
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in
Toggle navigation
C
Classical-MD-Modules
Project overview
Project overview
Details
Activity
Releases
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Issues
0
Issues
0
List
Boards
Labels
Service Desk
Milestones
Merge Requests
0
Merge Requests
0
CI / CD
CI / CD
Pipelines
Jobs
Schedules
Operations
Operations
Incidents
Environments
Analytics
Analytics
CI / CD
Repository
Value Stream
Wiki
Wiki
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Create a new issue
Jobs
Commits
Issue Boards
Open sidebar
Sarah McCartan
Classical-MD-Modules
Commits
01715135
Commit
01715135
authored
Oct 25, 2016
by
Alan O'Cais
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Only use bootstrap theme on readthedocs to keep things simple for people who clone the repo
parent
89b6f07f
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
81 additions
and
77 deletions
+81
-77
docs/conf.py
docs/conf.py
+81
-77
No files found.
docs/conf.py
View file @
01715135
...
...
@@ -120,83 +120,87 @@ todo_include_todos = True
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
html_theme
=
'bootstrap'
# 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
# documentation.
html_theme_options
=
{
# Navigation bar title. (Default: ``project`` value)
'navbar_title'
:
"Classical MD"
,
# Tab name for entire site. (Default: "Site")
'navbar_site_name'
:
"Site"
,
# Tab name for the current pages TOC. (Default: "Page")
'navbar_pagenav_name'
:
"Page"
,
# A list of tuples containing pages or urls to link to.
# Valid tuples should be in the following forms:
# (name, page) # a link to a page
# (name, "/aa/bb", 1) # a link to an arbitrary relative url
# (name, "http://example.com", True) # arbitrary absolute url
# Note the "1" or "True" value above as the third argument to indicate
# an arbitrary url.
# 'navbar_links': [
# ("Examples", "examples"),
# ("Link", "http://example.com", True),
# ],
# Global TOC depth for "site" navbar tab. (Default: 1)
# Switching to -1 shows all levels.
'globaltoc_depth'
:
2
,
# Include hidden TOCs in Site navbar?
#
# Note: If this is "false", you cannot have mixed ``:hidden:`` and
# non-hidden ``toctree`` directives in the same page, or else the build
# will break.
#
# Values: "true" (default) or "false"
'globaltoc_includehidden'
:
"true"
,
# HTML navbar class (Default: "navbar") to attach to <div> element.
# For black navbar, do "navbar navbar-inverse"
'navbar_class'
:
"navbar"
,
# Fix navigation bar to top of page?
# Values: "true" (default) or "false"
'navbar_fixed_top'
:
"true"
,
# Location of link to source.
# Options are "nav" (default), "footer" or anything else to exclude.
'source_link_position'
:
"nav"
,
# Bootswatch (http://bootswatch.com/) theme.
#
# Options are nothing (default) or the name of a valid theme such
# as "amelia" or "cosmo".
#
# Example themes:
# * flatly
# * sandstone (v3 only)
# * united
# * yeti (v3 only)
'bootswatch_theme'
:
"sandstone"
,
# Choose Bootstrap version.
# Values: "3" (default) or "2" (in quotes)
'bootstrap_version'
:
"3"
,
}
# Add any paths that contain custom themes here, relative to this directory.
# ``get_html_theme_path`` returns a list, so you can concatenate with
# any other theme directories you would like.
html_theme_path
=
sphinx_bootstrap_theme
.
get_html_theme_path
()
# The name for this set of Sphinx documents. If None, it defaults to
# "<project> v<release> documentation".
#html_title = None
on_rtd
=
os
.
environ
.
get
(
'READTHEDOCS'
,
None
)
==
'True'
if
on_rtd
:
html_theme
=
'bootstrap'
# 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
# documentation.
html_theme_options
=
{
# Navigation bar title. (Default: ``project`` value)
'navbar_title'
:
"Classical MD"
,
# Tab name for entire site. (Default: "Site")
'navbar_site_name'
:
"Site"
,
# Tab name for the current pages TOC. (Default: "Page")
'navbar_pagenav_name'
:
"Page"
,
# A list of tuples containing pages or urls to link to.
# Valid tuples should be in the following forms:
# (name, page) # a link to a page
# (name, "/aa/bb", 1) # a link to an arbitrary relative url
# (name, "http://example.com", True) # arbitrary absolute url
# Note the "1" or "True" value above as the third argument to indicate
# an arbitrary url.
# 'navbar_links': [
# ("Examples", "examples"),
# ("Link", "http://example.com", True),
# ],
# Global TOC depth for "site" navbar tab. (Default: 1)
# Switching to -1 shows all levels.
'globaltoc_depth'
:
2
,
# Include hidden TOCs in Site navbar?
#
# Note: If this is "false", you cannot have mixed ``:hidden:`` and
# non-hidden ``toctree`` directives in the same page, or else the build
# will break.
#
# Values: "true" (default) or "false"
'globaltoc_includehidden'
:
"true"
,
# HTML navbar class (Default: "navbar") to attach to <div> element.
# For black navbar, do "navbar navbar-inverse"
'navbar_class'
:
"navbar"
,
# Fix navigation bar to top of page?
# Values: "true" (default) or "false"
'navbar_fixed_top'
:
"true"
,
# Location of link to source.
# Options are "nav" (default), "footer" or anything else to exclude.
'source_link_position'
:
"nav"
,
# Bootswatch (http://bootswatch.com/) theme.
#
# Options are nothing (default) or the name of a valid theme such
# as "amelia" or "cosmo".
#
# Example themes:
# * flatly
# * sandstone (v3 only)
# * united
# * yeti (v3 only)
'bootswatch_theme'
:
"sandstone"
,
# Choose Bootstrap version.
# Values: "3" (default) or "2" (in quotes)
'bootstrap_version'
:
"3"
,
}
# Add any paths that contain custom themes here, relative to this directory.
# ``get_html_theme_path`` returns a list, so you can concatenate with
# any other theme directories you would like.
html_theme_path
=
sphinx_bootstrap_theme
.
get_html_theme_path
()
# The name for this set of Sphinx documents. If None, it defaults to
# "<project> v<release> documentation".
#html_title = None
else
:
html_theme
=
'default'
html_theme_options
=
{}
# A shorter title for the navigation bar. Default is the same as html_title.
#html_short_title = "Demo"
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
.
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment