[jira] [Commented] (ARROW-14460) [Doc] Use sphinx-remove-toctrees to generated docstring pages from navigation (and reduce build time)

["Joris Van den Bossche (Jira)" <ji...@apache.org>]

    [ https://issues.apache.org/jira/browse/ARROW-14460?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17433761#comment-17433761 ] 

Joris Van den Bossche commented on ARROW-14460:
-----------------------------------------------

I tried this out and it works nicely, but it also has a downside of then no longer "highlighting" the parent page in the navigation left-sidebar (which is somewhat annoying for our docs, since the sidebar is quite long and doesn't fit on a single page). See also https://github.com/executablebooks/sphinx-remove-toctrees/issues/1#issuecomment-950927077

On the other hand, with this change we can remove the if/else in the template here: https://github.com/apache/arrow/blob/be665ef948cb2c6706c60053c5db918e948713e8/docs/source/_templates/docs-sidebar.html#L13-L17 (and have it a single {{generate_nav_html}} call instead).

> [Doc] Use sphinx-remove-toctrees to generated docstring pages from navigation (and reduce build time)
> -----------------------------------------------------------------------------------------------------
>
>                 Key: ARROW-14460
>                 URL: https://issues.apache.org/jira/browse/ARROW-14460
>             Project: Apache Arrow
>          Issue Type: Improvement
>          Components: Documentation
>            Reporter: Joris Van den Bossche
>            Assignee: Joris Van den Bossche
>            Priority: Major
>
> The pydata-sphinx-theme tends to create large trees in the left-side navigation (and thus large generated large html sizes) because sphinx adds all generated docstring pages (from autosummary usage) to the global "toctrees". A small package (https://github.com/executablebooks/sphinx-remove-toctrees/) was created to help with this.
> See https://pydata-sphinx-theme.readthedocs.io/en/latest/user_guide/configuring.html#selectively-remove-pages-from-your-sidebar



--
This message was sent by Atlassian Jira
(v8.3.4#803005)