Permalink
Browse files

It was pointed out to me that the .. include:: directive can be used …

…to include ReST markup from other files, even if they're outside the doc source tree. This is a little less hacky than copying the faq and changelog into the source tree at build time.

git-svn-id: http://svn6.assembla.com/svn/pyfits/trunk@1804 ed100bfc-0583-0410-97f2-c26b58777a21
  • Loading branch information...
embray committed Sep 7, 2012
1 parent 35fdd4a commit 8d61d73ab3490bddaab64ac6a98cde0554d65f8f
Showing with 4 additions and 14 deletions.
  1. +0 −2 .gitignore
  2. +2 −2 CHANGES.txt
  3. +1 −0 docs/source/appendix/changelog.rst
  4. +1 −0 docs/source/appendix/faq.rst
  5. +0 −10 docs/source/conf.py
View
@@ -6,8 +6,6 @@
# Other generated files
lib/pyfits/version.py
-docs/source/appendix/changelog.rst
-docs/source/appendix/faq.rst
# Sphinx
_build
View
@@ -8,7 +8,7 @@ Changelog
3.1.1 (unreleased)
-----------------
+------------------
This is a bug fix release for the 3.1.x series.
@@ -21,7 +21,7 @@ Bug Fixes
3.0.10 (unreleased)
-----------------
+-------------------
This is a bug fix release for the 3.0.x series.
@@ -0,0 +1 @@
+.. include:: ../../../CHANGES.txt
@@ -0,0 +1 @@
+.. include:: ../../../FAQ.txt
View
@@ -271,13 +271,3 @@ def __getattr__(self, name):
# Example configuration for intersphinx: refer to the Python standard library.
# intersphinx_mapping = {'http://docs.python.org/': None}
-
-# Additional hacks
-
-# Copy the changelog and faq into the documentation source tree
-import shutil
-
-shutil.copy2(os.path.join(os.pardir, os.pardir, 'CHANGES.txt'),
- os.path.join('appendix', 'changelog.rst'))
-shutil.copy2(os.path.join(os.pardir, os.pardir, 'FAQ.txt'),
- os.path.join('appendix', 'faq.rst'))

0 comments on commit 8d61d73

Please sign in to comment.