Merge pull request #815 from noirbizarre/doc-versionning

Documentation versioning

bumpr.rc

@@ -0,0 +1,30 @@
+[bumpr]
+file = pelican/__init__.py
+vcs = git
+clean =
+    python setup.py clean
+    rm -rf *egg-info build dist
+tests = tox
+publish = python setup.py sdist register upload
+files = README.rst
+
+[bump]
+unsuffix = true
+message = Bump version {version}
+
+[prepare]
+part = patch
+suffix = dev
+message = Prepare version {version} for next development cycle
+
+[changelog]
+file = docs/changelog.rst
+separator = =
+bump = {version} ({date:%Y-%m-%d})
+prepare = Next release
+
+[readthedoc]
+url = http://docs.getpelican.com/{tag}
+
+[commands]
+bump = sed -i "s/last_stable\s*=.*/last_stable = '{version}'/" docs/conf.py

dev_requirements.txt

@@ -6,3 +6,6 @@ Markdown
 BeautifulSoup4
 lxml
 typogrify
+
+# To perform release
+bumpr==0.2.0

docs/changelog.rst

@@ -1,8 +1,8 @@
 Release history
 ###############
 
-3.3 (XXXX-XX-XX)
+Next release
-================
+============
 
 * Rename signals for better consistency (some plugins may need to be updated)
 * Move metadata extraction from generators to readers; metadata extraction no

docs/conf.py

@@ -4,18 +4,26 @@ import sys, os
 
 sys.path.append(os.path.abspath(os.pardir))
 
-from pelican import __version__, __major__
+from pelican import __version__
 
 # -- 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 = __version__
-release = __major__
+version = '.'.join(release.split('.')[:1])
+last_stable = '3.2.2'
+rst_prolog = '''
+.. |last_stable| replace:: :pelican-doc:`{0}`
+'''.format(last_stable)
+
+extlinks = {
+    'pelican-doc':  ('http://docs.getpelican.com/%s/', '')
+}
 
 # -- Options for HTML output ---------------------------------------------------
 

docs/index.rst

@@ -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

pelican/__init__.py

@@ -22,10 +22,7 @@ from pelican.settings import read_settings
 from pelican.utils import clean_output_dir, folder_watcher, file_watcher
 from pelican.writers import Writer
 
-__major__ = 3
+__version__ = "3.2.3.dev"
-__minor__ = 2
-__micro__ = 0
-__version__ = "{0}.{1}.{2}".format(__major__, __minor__, __micro__)
 
 DEFAULT_CONFIG_NAME = 'pelicanconf.py'