From 9b15a8dcd25bd2fa59d744dce07c7659366dfdae Mon Sep 17 00:00:00 2001 From: Adam Turner <9087854+aa-turner@users.noreply.github.com> Date: Tue, 30 Jul 2024 19:56:50 +0100 Subject: [PATCH] Move Sphinx 0.3 CHANGES to a dedicated file --- CHANGES.rst | 60 ------------------------------------------- doc/changes/0.3.rst | 60 +++++++++++++++++++++++++++++++++++++++++++ doc/changes/index.rst | 1 + 3 files changed, 61 insertions(+), 60 deletions(-) create mode 100644 doc/changes/0.3.rst diff --git a/CHANGES.rst b/CHANGES.rst index e5ab83c8b..b48dacded 100644 --- a/CHANGES.rst +++ b/CHANGES.rst @@ -9425,63 +9425,3 @@ Bugs fixed which plays nicer with tables. * Fix bug with directories in the HTML builder static path. - - -Release 0.3 (May 6, 2008) -========================= - -New features added ------------------- - -* The ``toctree`` directive now supports a ``glob`` option that allows - glob-style entries in the content. - -* If the ``pygments_style`` config value contains a dot it's treated as the - import path of a custom Pygments style class. - -* A new config value, ``exclude_dirs``, can be used to exclude whole - directories from the search for source files. - -* The configuration directory (containing ``conf.py``) can now be set - independently from the source directory. For that, a new command-line - option ``-c`` has been added. - -* A new directive ``tabularcolumns`` can be used to give a tabular column - specification for LaTeX output. Tables now use the ``tabulary`` package. - Literal blocks can now be placed in tables, with several caveats. - -* A new config value, ``latex_use_parts``, can be used to enable parts in LaTeX - documents. - -* Autodoc now skips inherited members for classes, unless you give the - new ``inherited-members`` option. - -* A new config value, ``autoclass_content``, selects if the docstring of the - class' ``__init__`` method is added to the directive's body. - -* Support for C++ class names (in the style ``Class::Function``) in C function - descriptions. - -* Support for a ``toctree_only`` item in items for the ``latex_documents`` - config value. This only includes the documents referenced by TOC trees in the - output, not the rest of the file containing the directive. - -Bugs fixed ----------- - -* sphinx.htmlwriter: Correctly write the TOC file for any structure of the - master document. Also encode non-ASCII characters as entities in TOC - and index file. Remove two remaining instances of hard-coded - "documentation". - -* sphinx.ext.autodoc: descriptors are detected properly now. - -* sphinx.latexwriter: implement all reST admonitions, not just ``note`` - and ``warning``. - -* Lots of little fixes to the LaTeX output and style. - -* Fix OpenSearch template and make template URL absolute. The - ``html_use_opensearch`` config value now must give the base URL. - -* Some unused files are now stripped from the HTML help file build. diff --git a/doc/changes/0.3.rst b/doc/changes/0.3.rst new file mode 100644 index 000000000..e3501e2d1 --- /dev/null +++ b/doc/changes/0.3.rst @@ -0,0 +1,60 @@ + + +Release 0.3 (May 6, 2008) +========================= + +New features added +------------------ + +* The ``toctree`` directive now supports a ``glob`` option that allows + glob-style entries in the content. + +* If the ``pygments_style`` config value contains a dot it's treated as the + import path of a custom Pygments style class. + +* A new config value, ``exclude_dirs``, can be used to exclude whole + directories from the search for source files. + +* The configuration directory (containing ``conf.py``) can now be set + independently from the source directory. For that, a new command-line + option ``-c`` has been added. + +* A new directive ``tabularcolumns`` can be used to give a tabular column + specification for LaTeX output. Tables now use the ``tabulary`` package. + Literal blocks can now be placed in tables, with several caveats. + +* A new config value, ``latex_use_parts``, can be used to enable parts in LaTeX + documents. + +* Autodoc now skips inherited members for classes, unless you give the + new ``inherited-members`` option. + +* A new config value, ``autoclass_content``, selects if the docstring of the + class' ``__init__`` method is added to the directive's body. + +* Support for C++ class names (in the style ``Class::Function``) in C function + descriptions. + +* Support for a ``toctree_only`` item in items for the ``latex_documents`` + config value. This only includes the documents referenced by TOC trees in the + output, not the rest of the file containing the directive. + +Bugs fixed +---------- + +* sphinx.htmlwriter: Correctly write the TOC file for any structure of the + master document. Also encode non-ASCII characters as entities in TOC + and index file. Remove two remaining instances of hard-coded + "documentation". + +* sphinx.ext.autodoc: descriptors are detected properly now. + +* sphinx.latexwriter: implement all reST admonitions, not just ``note`` + and ``warning``. + +* Lots of little fixes to the LaTeX output and style. + +* Fix OpenSearch template and make template URL absolute. The + ``html_use_opensearch`` config value now must give the base URL. + +* Some unused files are now stripped from the HTML help file build. diff --git a/doc/changes/index.rst b/doc/changes/index.rst index 392e35c08..457adcc16 100644 --- a/doc/changes/index.rst +++ b/doc/changes/index.rst @@ -24,5 +24,6 @@ Prior releases .. toctree:: :maxdepth: 2 + 0.3 0.2 0.1