Skip to content

BUG: Fix bug with orphan sg_api_usage#1207

Merged
larsoner merged 4 commits intosphinx-gallery:masterfrom
larsoner:orphan
Oct 5, 2023
Merged

BUG: Fix bug with orphan sg_api_usage#1207
larsoner merged 4 commits intosphinx-gallery:masterfrom
larsoner:orphan

Conversation

@larsoner
Copy link
Copy Markdown
Contributor

@larsoner larsoner commented Oct 4, 2023

Fixes this bug when running in noplot mode:

checking consistency... /Users/larsoner/python/mne-python/doc/sg_api_usage.rst: WARNING: document isn't included in any toctree

The :orphan: and title should always be added.

Also snuck in some changelog_generator stuff to speed things up that I've been using elsewhere that should help at release time.

@larsoner larsoner added the bug label Oct 4, 2023
@larsoner
Copy link
Copy Markdown
Contributor Author

larsoner commented Oct 4, 2023

This one should be ready to go @lucyleeow !

Copy link
Copy Markdown
Contributor

@lucyleeow lucyleeow left a comment

Choose a reason for hiding this comment

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

LGTM, thanks! Just one question.

user=sphinx-gallery
add-sections={"api":{"prefix":"**API changes**","labels":["api"]},"documentation":{"prefix":"**Documentation**","labels":["documentation"]},"maintenance":{"prefix": "**Project maintenance**","labels":["maintenance"]}}
max-issues=200
max-issues=2
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Why do we only want to fetch 2 issues? We should want a few months worth right?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

We actually already have issues=no meaning "don't put any issues . It's a mystery to me why it even bothers fetching issues when this is the case but it did (at least at some point).

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Ah right, did not realise. So for the changelog we only use PRs? I thought we, at some point, used issues as well?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Yes we used to but in practice they didn't seem to add much value compared to properly listing PRs so I removed them

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Good to know, I tend to agree. Some issues are just quickly resolved without anything needing to be done and thus did not really add anything to the changelog.

@larsoner larsoner merged commit 7725679 into sphinx-gallery:master Oct 5, 2023
@larsoner larsoner deleted the orphan branch October 5, 2023 05:54
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