Skip to content

FIX: Add blank line at end of table of contents block#1094

Merged
larsoner merged 1 commit intosphinx-gallery:masterfrom
sdhiscocks:toc_tree
Mar 9, 2023
Merged

FIX: Add blank line at end of table of contents block#1094
larsoner merged 1 commit intosphinx-gallery:masterfrom
sdhiscocks:toc_tree

Conversation

@sdhiscocks
Copy link
Copy Markdown
Contributor

@sdhiscocks sdhiscocks commented Mar 9, 2023

Without this, it can come up against a next text block, e.g. subsection title, which will cause indentation error.

Example below of issue raising ...\auto_tutorials\index.rst:204:Explicit markup ends without a blank line; unexpected unindent.

Before:

.. toctree::
   :hidden:

   /auto_tutorials/01_KalmanFilterTutorial
   /auto_tutorials/02_ExtendedKalmanFilterTutorial
   /auto_tutorials/03_UnscentedKalmanFilterTutorial
   /auto_tutorials/04_ParticleFilter
   /auto_tutorials/05_DataAssociation-Clutter
   /auto_tutorials/06_DataAssociation-MultiTargetTutorial
   /auto_tutorials/07_PDATutorial
   /auto_tutorials/08_JPDATutorial
   /auto_tutorials/09_Initiators_&_Deleters
   /auto_tutorials/10_Simulation_&_Tracking_Components
Filters
-------
Here are some tutorials which cover additional filtering techniques.

After (applying this PR):

.. toctree::
   :hidden:

   /auto_tutorials/01_KalmanFilterTutorial
   /auto_tutorials/02_ExtendedKalmanFilterTutorial
   /auto_tutorials/03_UnscentedKalmanFilterTutorial
   /auto_tutorials/04_ParticleFilter
   /auto_tutorials/05_DataAssociation-Clutter
   /auto_tutorials/06_DataAssociation-MultiTargetTutorial
   /auto_tutorials/07_PDATutorial
   /auto_tutorials/08_JPDATutorial
   /auto_tutorials/09_Initiators_&_Deleters
   /auto_tutorials/10_Simulation_&_Tracking_Components

Filters
-------
Here are some tutorials which cover additional filtering techniques.

Without this, it can come up against a next text block, e.g. subsection
title, which will cause indentation error.
@larsoner
Copy link
Copy Markdown
Contributor

larsoner commented Mar 9, 2023

Argh yes this seems like a regression and a reasonable fix. I'll merge and backport to a maint/0.12 branch, bump to 0.12.1 there, and cut a bugfix release. Thanks @sdhiscocks !

@larsoner larsoner merged commit 220e1af into sphinx-gallery:master Mar 9, 2023
@sdhiscocks sdhiscocks deleted the toc_tree branch March 9, 2023 16:17
@larsoner
Copy link
Copy Markdown
Contributor

larsoner commented Mar 9, 2023

0.12.1 cut with this fix: https://pypi.org/project/sphinx-gallery/0.12.1/

clrpackages referenced this pull request in clearlinux-pkgs/pypi-sphinx_gallery Mar 11, 2023
… to version 0.12.1

v0.12.1
-------

**Fixed bugs:**

-  BUG: Fix bug with show_api_usage `#1095 <https://github.com/sphinx-gallery/sphinx-gallery/pull/1095>`__ (`larsoner <https://github.com/larsoner>`__)
-  FIX: Add blank line at end of table of contents block `#1094 <https://github.com/sphinx-gallery/sphinx-gallery/pull/1094>`__ (`sdhiscocks <https://github.com/sdhiscocks>`__)

v0.12.0
-------
Support for Sphinx < 4 dropped in this release. Requirement is Sphinx >= 4.

**Implemented enhancements:**

-  ENH: allow rst files to pass through `#1071 <https://github.com/sphinx-gallery/sphinx-gallery/pull/1071>`__ (`jklymak <https://github.com/jklymak>`__)

(NEWS truncated at 15 lines)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants