Skip to content

fix double-toc - #15119

Merged
pllim merged 1 commit into
astropy:mainfrom
nstarman:cosmo-docs-double-toc
Aug 3, 2023
Merged

fix double-toc#15119
pllim merged 1 commit into
astropy:mainfrom
nstarman:cosmo-docs-double-toc

Conversation

@nstarman

@nstarman nstarman commented Aug 2, 2023

Copy link
Copy Markdown
Member

Fixes #15117

@nstarman nstarman added this to the v6.0 milestone Aug 2, 2023
@nstarman
nstarman requested a review from pllim August 2, 2023 22:23
@github-actions

github-actions Bot commented Aug 2, 2023

Copy link
Copy Markdown
Contributor

Thank you for your contribution to Astropy! 🌌 This checklist is meant to remind the package maintainers who will review this pull request of some common things to look for.

  • Do the proposed changes actually accomplish desired goals?
  • Do the proposed changes follow the Astropy coding guidelines?
  • Are tests added/updated as required? If so, do they follow the Astropy testing guidelines?
  • Are docs added/updated as required? If so, do they follow the Astropy documentation guidelines?
  • Is rebase and/or squash necessary? If so, please provide the author with appropriate instructions. Also see "When to rebase and squash commits".
  • Did the CI pass? If no, are the failures related? If you need to run daily and weekly cron jobs as part of the PR, please apply the "Extra CI" label. Codestyle issues can be fixed by the bot.
  • Is a change log needed? If yes, did the change log check pass? If no, add the "no-changelog-entry-needed" label. If this is a manual backport, use the "skip-changelog-checks" label unless special changelog handling is necessary.
  • Is this a big PR that makes a "What's new?" entry worthwhile and if so, is (1) a "what's new" entry included in this PR and (2) the "whatsnew-needed" label applied?
  • Is a milestone set? Milestone must be set but we cannot check for it on Actions; do not let the green checkmark fool you.
  • At the time of adding the milestone, if the milestone set requires a backport to release branch(es), apply the appropriate "backport-X.Y.x" label(s) before merge.

@github-actions

github-actions Bot commented Aug 2, 2023

Copy link
Copy Markdown
Contributor

👋 Thank you for your draft pull request! Do you know that you can use [ci skip] or [skip ci] in your commit messages to skip running continuous integration tests until you are ready?

@nstarman
nstarman force-pushed the cosmo-docs-double-toc branch from 8d69b2f to d292f3f Compare August 2, 2023 22:58
pllim
pllim reviewed Aug 3, 2023
View reviewed changes
Comment thread docs/cosmology/index.rst Outdated

.. toctree::
:maxdepth: 1
.. contents::

@pllim pllim Aug 3, 2023

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Gives error:

docs/cosmology/index.rst:111: ERROR: Error in "contents" directive:
no content permitted.

.. contents::

   io/index
   Units and Equivalencies <units>
   For Developers <dev>

@pllim pllim Aug 3, 2023

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

docs/visualization also has a sub-directory with its own index. Maybe you can compare between this and that one and see...

https://docs.astropy.org/en/latest/visualization/index.html

@nstarman
nstarman force-pushed the cosmo-docs-double-toc branch from d292f3f to 257e90e Compare August 3, 2023 05:49
@nstarman
nstarman marked this pull request as ready for review August 3, 2023 06:09
@nstarman
nstarman requested a review from a team as a code owner August 3, 2023 06:09
@nstarman
nstarman requested a review from pllim August 3, 2023 06:09
@pllim

pllim commented Aug 3, 2023

Copy link
Copy Markdown
Member

Duplicates are gone but I think the ordering can be improved.

Screenshot 2023-08-03 103411

Maybe move "Reference/API" to the end to be consistent with other subpackages?

@nstarman
fix double-toc
74fef2f 
Signed-off-by: nstarman <[email protected]>
@nstarman
nstarman force-pushed the cosmo-docs-double-toc branch from 257e90e to 74fef2f Compare August 3, 2023 16:45
pllim
pllim approved these changes Aug 3, 2023
View reviewed changes

@pllim pllim left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

LGTM now. Thanks for the quick fix!

@pllim
pllim merged commit 312a417 into astropy:main Aug 3, 2023
@nstarman
nstarman deleted the cosmo-docs-double-toc branch August 3, 2023 18:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@pllim pllim pllim approved these changes

Assignees

No one assigned

Labels

Bug cosmology Docs no-changelog-entry-needed

Projects

Cosmology, the Expansion
Status: Done

Milestone

v6.0.0

Development

Successfully merging this pull request may close these issues.

DOC: Cosmology section has repeated sub-sections

2 participants

@nstarman @pllim