jan/debianmemberportfolio
1
0
Fork 1
Code Issues Pull requests Releases Wiki Activity

prepare sphinx documentation building

Browse source 
* docs/conf.py:
  - add sphinx.ext.viewcode to extensions
  - update copyright years
  - bump version numbers
  - explicitly define language
* setup.cfg
  - define output directory and add all_files directive
This commit is contained in:
Jan Dittberner 2013-02-24 21:56:02 +01:00
parent 9efe6a7b28
commit 98b7bc2676
2 changed files with 7 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
docs/conf.py
View file

@ -26,7 +26,7 @@ import sys, os
# Add any Sphinx extension module names here, as strings. They can be extensions # Add any Sphinx extension module names here, as strings. They can be extensions
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones. # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
extensions = ['sphinx.ext.autodoc'] extensions = ['sphinx.ext.autodoc', 'sphinx.ext.viewcode']
# Add any paths that contain templates here, relative to this directory. # Add any paths that contain templates here, relative to this directory.
templates_path = ['.templates'] templates_path = ['.templates']
@ -42,20 +42,20 @@ master_doc = 'index'
# General information about the project. # General information about the project.
project = u'Debian Developer Portfolio Service' project = u'Debian Developer Portfolio Service'
copyright = u'2009, Jan Dittberner' copyright = u'2009-2013, Jan Dittberner'
# The version info for the project you're documenting, acts as replacement for # The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the # |version| and |release|, also used in various other places throughout the
# built documents. # built documents.
# #
# The short X.Y version. # The short X.Y version.
version = '0.1' version = '0.2.18'
# The full version, including alpha/beta/rc tags. # The full version, including alpha/beta/rc tags.
release = '0.1dev' release = '0.2.18dev'
# The language for content autogenerated by Sphinx. Refer to documentation # The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages. # for a list of supported languages.
#language = None language = 'en'
# There are two options for replacing |today|: either, you set today to some # There are two options for replacing |today|: either, you set today to some
# non-false value, then it is used: # non-false value, then it is used:

2
setup.cfg
View file

@ -7,6 +7,8 @@ find_links = http://www.pylonshq.com/download/
[build_sphinx] [build_sphinx]
source-dir = docs source-dir = docs
build-dir = docs/html
all_files = 1
[publish] [publish]
doc-dir=docs/html doc-dir=docs/html