sphinx/doc/changes.rst

:tocdepth: 1

.. default-role:: any

.. _changes:

=========
Changelog
=========

.. raw:: latex

   \hypersetup{bookmarksdepth=1}% pdf bookmarks
   \addtocontents{toc}{\protect\setcounter{tocdepth}{1}}%

.. include:: ../CHANGES
doc: Hide changelog entries on ToC page 2020-03-28 22:01:32 +09:00			`:tocdepth: 1`
Add maxdepth for TOCs. 2008-06-12 21:56:06 +00:00
Use "any" role in changelog. 2014-09-19 13:18:29 +02:00			`.. default-role:: any`

Support app.add_crossref_type(). 2008-03-28 18:45:32 +00:00			`.. _changes:`

docs: Rework contributing document, re-add CONTRIBUTING Reorder this to flow a little better and re-add the CONTRIBUTING document, which now simply points to the main documentation. Signed-off-by: Stephen Finucane <stephen@that.guru> 2020-05-30 15:08:50 +01:00			`=========`
			`Changelog`
			`=========`
Add the changelog to the documentation. 2008-03-23 21:25:19 +00:00
Improve Sphinx own pdf docs Prior to this the depth of the bookmarks is too low, one does not even get to see for example what are the built-in extensions offered by Sphinx. Similarly the LaTeX created table of contents has not enough depth. Dozens of contiguous pages from our documentation get only a single link, it is very hard for newcomer to get some feeling of the scope of Sphinx. With a more detailed table of contents (be it inside the PDF or via the collapsable bookmark panel of PDF viewer) learning Sphinx is easier. 2021-01-24 00:41:59 +01:00			`.. raw:: latex`

			`\hypersetup{bookmarksdepth=1}% pdf bookmarks`
			`\addtocontents{toc}{\protect\setcounter{tocdepth}{1}}%`

Add the changelog to the documentation. 2008-03-23 21:25:19 +00:00			`.. include:: ../CHANGES`