Skip to content

DOC: Implementing single doc building for api docs #19864

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
wants to merge 1 commit into from
Closed

DOC: Implementing single doc building for api docs #19864

wants to merge 1 commit into from

Conversation

datapythonista
Copy link
Member

Same as #19840, using @jorisvandenbossche approach, but using the --single attribute instead of separate functionality for docstrings.

@jorisvandenbossche
Copy link
Member

Thanks, will take a look this weekend.
Reusing index.rst instead of my temp.rst is a nice idea!

Functionality wise, I think you dropped the multiple docstrings at once?

@datapythonista
Copy link
Member Author

Yes, but I think it should be easy to restore it with this approach, just wanted to share the idea first, before going into too much detail with the code.

Functionality wise, I don't think it works with this PR, but building the pdf for a single docstring should be "trivial" to have with this method.

I find this method simpler, that's why I wanted to test it, and I prefer it if there is no drawback I missed. For the rest they should be almost the same.

@jreback jreback added the Docs label Feb 24, 2018
@jorisvandenbossche
Copy link
Member

@datapythonista I just worked a bit further on it on the train, and added your commit to my other PR and made some further changes (I basically just added back the copying of existing generated rst file, because those are in some cases more correct). See #19840

@jorisvandenbossche
Copy link
Member

Closing this one in favor of #19840

@jorisvandenbossche jorisvandenbossche added this to the No action milestone Feb 26, 2018
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.

3 participants