diff options
author | 2014-10-27 01:29:24 -0400 | |
---|---|---|
committer | 2014-10-27 01:42:32 -0400 | |
commit | ac8c2818a6bc858fa9f46faebb397cf283110030 (patch) | |
tree | ed4ebe72fdf0b0007a85bdc12bb8d15cfc06ac29 /doc | |
parent | Revert "travis-ci: force pylint testing against the installed module" (diff) | |
download | snakeoil-ac8c2818a6bc858fa9f46faebb397cf283110030.tar.gz snakeoil-ac8c2818a6bc858fa9f46faebb397cf283110030.tar.bz2 snakeoil-ac8c2818a6bc858fa9f46faebb397cf283110030.zip |
convert NEWS and README into rst files
This allows use to use the github renderer to show a better README file
by default and deprecate/drop the usage of the custom txt -> rst news
generation method for building the docs.
Diffstat (limited to 'doc')
-rw-r--r-- | doc/Makefile | 6 | ||||
l--------- | doc/news.rst | 1 |
2 files changed, 2 insertions, 5 deletions
diff --git a/doc/Makefile b/doc/Makefile index fb81cca4..c1cc5415 100644 --- a/doc/Makefile +++ b/doc/Makefile @@ -41,7 +41,7 @@ help: clean: -rm -rf $(BUILDDIR) api -generated: api news +generated: api api: @echo "autogenerating api rsts..." @@ -51,10 +51,6 @@ api: do echo $${fn} api/$${fn}.rst; \ done | $(PYTHON) -m snakeoil.sphinx_utils.generate_api_rsts -news: - @echo "autogenerating news.rst..." - $(PYTHON) -m snakeoil.sphinx_utils.generate_news_rst snakeoil ../NEWS news.rst 'git_release' 'git_tag' - html: generated $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html @echo diff --git a/doc/news.rst b/doc/news.rst new file mode 120000 index 00000000..e0135754 --- /dev/null +++ b/doc/news.rst @@ -0,0 +1 @@ +../NEWS.rst
\ No newline at end of file |