ets-labs/python-dependency-injector
1
1
Fork 0
mirror of https://github.com/ets-labs/python-dependency-injector.git synced 2025-02-16 19:40:59 +03:00
Code Issues Packages Projects Releases Wiki Activity

Adding rtd theme, name update

Browse Source
This commit is contained in:
Roman Mogilatov 2015-04-02 11:57:33 +03:00
parent 13496f78d3
commit 4ef113f28b
2 changed files with 22 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
docs/conf.py
View File

@ -1,6 +1,6 @@
# -*- coding: utf-8 -*- # -*- coding: utf-8 -*-
# #
# objects documentation build configuration file, created by # Objects documentation build configuration file, created by
# sphinx-quickstart on Wed Apr 1 17:36:06 2015. # sphinx-quickstart on Wed Apr 1 17:36:06 2015.
# #
# This file is execfile()d with the current directory set to its # This file is execfile()d with the current directory set to its
@ -46,7 +46,7 @@ source_suffix = '.rst'
master_doc = 'index' master_doc = 'index'
# General information about the project. # General information about the project.
project = u'objects' project = u'Objects'
copyright = u'2015, Roman Mogilatov' copyright = u'2015, Roman Mogilatov'
author = u'Roman Mogilatov' author = u'Roman Mogilatov'
@ -202,6 +202,17 @@ html_static_path = ['_static']
# Output file base name for HTML help builder. # Output file base name for HTML help builder.
htmlhelp_basename = 'objectsdoc' htmlhelp_basename = 'objectsdoc'
# on_rtd is whether we are on readthedocs.org, this line of code grabbed from
# docs.readthedocs.org
on_rtd = os.environ.get('READTHEDOCS', None) == 'True'
if not on_rtd: # only import and set the theme if we're building docs locally
import sphinx_rtd_theme
html_theme = 'sphinx_rtd_theme'
html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
# otherwise, readthedocs.org uses their theme by default, so no need to
# specify it
# -- Options for LaTeX output --------------------------------------------- # -- Options for LaTeX output ---------------------------------------------
latex_elements = { latex_elements = {
@ -222,7 +233,7 @@ latex_elements = {
# (source start file, target name, title, # (source start file, target name, title,
# author, documentclass [howto, manual, or own class]). # author, documentclass [howto, manual, or own class]).
latex_documents = [ latex_documents = [
(master_doc, 'objects.tex', u'objects Documentation', (master_doc, 'Objects.tex', u'Objects Documentation',
u'Roman Mogilatov', 'manual'), u'Roman Mogilatov', 'manual'),
] ]
@ -252,7 +263,7 @@ latex_documents = [
# One entry per manual page. List of tuples # One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section). # (source start file, name, description, authors, manual section).
man_pages = [ man_pages = [
(master_doc, 'objects', u'objects Documentation', (master_doc, 'Objects', u'Objects Documentation',
[author], 1) [author], 1)
] ]
@ -266,8 +277,8 @@ man_pages = [
# (source start file, target name, title, author, # (source start file, target name, title, author,
# dir menu entry, description, category) # dir menu entry, description, category)
texinfo_documents = [ texinfo_documents = [
(master_doc, 'objects', u'objects Documentation', (master_doc, 'Objects', u'Objects Documentation',
author, 'objects', 'One line description of project.', author, 'Objects', 'One line description of project.',
'Miscellaneous'), 'Miscellaneous'),
] ]

8
docs/index.rst
View File

@ -1,13 +1,15 @@
.. objects documentation master file, created by .. Objects documentation master file, created by
sphinx-quickstart on Wed Apr 1 17:36:06 2015. sphinx-quickstart on Wed Apr 1 17:36:06 2015.
You can adapt this file completely to your liking, but it should at least You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive. contain the root `toctree` directive.
Welcome to objects's documentation! Welcome to Objects documentation!
=================================== =================================
Contents: Contents:
asdadas
.. toctree:: .. toctree::
:maxdepth: 2 :maxdepth: 2