Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DOC: restore toctree maxdepth #25134

Merged
merged 7 commits into from
Mar 11, 2019
Merged

DOC: restore toctree maxdepth #25134

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
ade2608
DOC: restore toctree maxdepth
jorisvandenbossche Feb 4, 2019
1c41116
Merge remote-tracking branch 'upstream/master' into doc-toctree
jorisvandenbossche Mar 10, 2019
d092acf
make it hidden + make sure it is still in sidebar
jorisvandenbossche Mar 10, 2019
42b3283
Add toctree for front page manually
jorisvandenbossche Mar 10, 2019
4b27492
use commented toctree's instead of hidden for api pages to avoid warn…
jorisvandenbossche Mar 11, 2019
262772f
0.24.1 -> 0.25.0
jorisvandenbossche Mar 11, 2019
789e7c7
add comment in subsection toctrees to also update main manual toctree
jorisvandenbossche Mar 11, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
use commented toctree's instead of hidden for api pages to avoid warn… 
…ings
  • Loading branch information
@jorisvandenbossche
jorisvandenbossche committed Mar 11, 2019
commit 4b27492e1458d27273c8261a763421f93742561d
2 changes: 1 addition & 1 deletion doc/source/index.rst.template
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ See the :ref:`overview` for more detail about what's in the library.
{% if not single_doc -%}
development/index
whatsnew/index
{% endif -%}
{% endif -%}


* :doc:`whatsnew/v0.24.1`
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

is this right?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's the link we currently have on the main page (I only omitted the subsections for this page)

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah, I suppose you meant the "0.24.1". That should indeed be 0.25.0 for master (and needs to be changed to 0.24.2 on the 0.24.x branch), thanks for the catch.

Expand Down
60 changes: 30 additions & 30 deletions doc/source/reference/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,40 +41,40 @@ public functions related to data types in pandas.
.. This is to prevent warnings in the doc build. We don't want to encourage
.. these methods.

.. toctree::
:hidden:
..
.. toctree::

api/pandas.DataFrame.blocks
api/pandas.DataFrame.as_matrix
api/pandas.DataFrame.ix
api/pandas.Index.asi8
api/pandas.Index.data
api/pandas.Index.flags
api/pandas.Index.holds_integer
api/pandas.Index.is_type_compatible
api/pandas.Index.nlevels
api/pandas.Index.sort
api/pandas.Panel.agg
api/pandas.Panel.aggregate
api/pandas.Panel.blocks
api/pandas.Panel.empty
api/pandas.Panel.is_copy
api/pandas.Panel.items
api/pandas.Panel.ix
api/pandas.Panel.major_axis
api/pandas.Panel.minor_axis
api/pandas.Series.asobject
api/pandas.Series.blocks
api/pandas.Series.from_array
api/pandas.Series.ix
api/pandas.Series.imag
api/pandas.Series.real
api/pandas.DataFrame.blocks
api/pandas.DataFrame.as_matrix
api/pandas.DataFrame.ix
api/pandas.Index.asi8
api/pandas.Index.data
api/pandas.Index.flags
api/pandas.Index.holds_integer
api/pandas.Index.is_type_compatible
api/pandas.Index.nlevels
api/pandas.Index.sort
api/pandas.Panel.agg
api/pandas.Panel.aggregate
api/pandas.Panel.blocks
api/pandas.Panel.empty
api/pandas.Panel.is_copy
api/pandas.Panel.items
api/pandas.Panel.ix
api/pandas.Panel.major_axis
api/pandas.Panel.minor_axis
api/pandas.Series.asobject
api/pandas.Series.blocks
api/pandas.Series.from_array
api/pandas.Series.ix
api/pandas.Series.imag
api/pandas.Series.real


.. Can't convince sphinx to generate toctree for this class attribute.
.. So we do it manually to avoid a warning

.. toctree::
:hidden:
..
.. toctree::

api/pandas.api.extensions.ExtensionDtype.na_value
api/pandas.api.extensions.ExtensionDtype.na_value