1
0
Fork 0
forked from github/pelican

Include version in doc and warn if it's a dev version.

This commit is contained in:
Axel Haustant 2013-03-27 09:16:19 +01:00
commit 469c531ae4
2 changed files with 24 additions and 7 deletions

View file

@ -4,18 +4,26 @@ import sys, os
sys.path.append(os.path.abspath(os.pardir))
from pelican import __version__, __major__
from pelican import __version__, __major__, __minor__
# -- General configuration -----------------------------------------------------
templates_path = ['_templates']
extensions = ['sphinx.ext.autodoc',]
extensions = ['sphinx.ext.autodoc', 'sphinx.ext.ifconfig', 'sphinx.ext.extlinks']
source_suffix = '.rst'
master_doc = 'index'
project = 'Pelican'
copyright = '2010, Alexis Metaireau and contributors'
exclude_patterns = ['_build']
version = __version__
release = __major__
version = '%s.%s' % (__major__, __minor__)
release = __version__
last_stable = '3.1.1'
rst_prolog = '''
.. |last_stable| replace:: :pelican-doc:`{0}`
'''.format(last_stable)
extlinks = {
'pelican-doc': ('http://docs.getpelican.com/%s/', '')
}
# -- Options for HTML output ---------------------------------------------------

View file

@ -1,5 +1,14 @@
Pelican
=======
Pelican |release|
=================
.. ifconfig:: release.endswith('.dev')
.. warning::
This documentation is for the version of Pelican currently under development.
Were you looking for version |last_stable| documentation?
Pelican is a static site generator, written in Python_.
@ -12,7 +21,7 @@ Pelican is a static site generator, written in Python_.
Features
--------
Pelican currently supports:
Pelican |version| currently supports:
* Articles (e.g., blog posts) and pages (e.g., "About", "Projects", "Contact")
* Comments, via an external service (Disqus). (Please note that while