Skip to content

DOC: API docs broken with sphinx 1.3.x #10316

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

Closed
jorisvandenbossche opened this issue Jun 9, 2015 · 4 comments
Closed

DOC: API docs broken with sphinx 1.3.x #10316

jorisvandenbossche opened this issue Jun 9, 2015 · 4 comments
Labels

Comments

@jorisvandenbossche
Copy link
Member

Just to track this on our side: as raised by @shoyer, there is a bug in the latest sphinx version that causes part of the API docs not to built.

Sphinx bug report: sphinx-doc/sphinx#1822, pr: sphinx-doc/sphinx#1828

@jorisvandenbossche
Copy link
Member Author

Once this is solved, probably good to update the version used in our travis doc build (now it is 1.1.3) to just the latest sphinx.

@embray
Copy link
Contributor

embray commented Jun 9, 2015

As a workaround you can subclass the Automodsumm extension and override the get_items method as demonstrated here: https://github.com/astropy/astropy-helpers/pull/148/files#diff-c95430c65faa667beb1feea7abfb3fd6R188

@jorisvandenbossche
Copy link
Member Author

Just tested this, and it seems to work with the new sphinx release (>= 1.3.2). Only, now the accessor docs do not link correctly anymore in API overview.

@jorisvandenbossche
Copy link
Member Author

As mentioned above, this is fixed in more recent versions of Sphinx, and the broken accessor docs are tracked here: #12161

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants