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.

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

Improvements to edit_on_github extension #6

Open
2 tasks
astrofrog opened this issue Feb 21, 2018 · 0 comments
Open
2 tasks

Improvements to edit_on_github extension #6

astrofrog opened this issue Feb 21, 2018 · 0 comments
Labels
enhancement New feature or request help wanted Extra attention is needed

Comments

@astrofrog
Copy link
Member

Originally requested by @embray in astropy/astropy-helpers#211

In astropy/astropy#4361 (comment) I suggested a few fixes to the edit_on_github Sphinx extension that might be worth making:

  • If the doctree argument passed to html_page_content is None, this implies an HTML page that was not generated from an actual rst document. Usually this implies that there is no page to edit on GitHub, though I suppose a static HTML page that lives in the repository is also possible. In either case, the case of doctree is None should be handled in some appropriate way. Currently if doctree is None for a page that is not skipped, the extension crashes.
  • The default for edit_on_github_skip_regex should be updated, probably to include api.* pages for compatibility with automodapi. Better yet, maybe the extension can check if automodapi is being used, and automatically skip anything that starts with the value for the automodapi_toctreedirnm config option used by automodapi.
@astrofrog astrofrog added enhancement New feature or request help wanted Extra attention is needed labels Feb 21, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

1 participant