Skip to content

Use sphinx autodoc for API #1

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.

Sign up for GitHub

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

Jump to bottom
Closed
iMichka opened this issue May 21, 2014 · 2 comments
Closed

Use sphinx autodoc for API #1

iMichka opened this issue May 21, 2014 · 2 comments
Assignees
@iMichka
Labels
documentation
Milestone
1.9.0

Comments

@iMichka
Copy link
Collaborator

iMichka commented May 21, 2014

We need to setup sphinx autodoc for the API documentation. This is far easier to maintain than using manually created .rst files for each package.
@iMichka iMichka added this to the 1.6.0 milestone May 21, 2014
@iMichka iMichka self-assigned this May 21, 2014
@iMichka iMichka removed this from the 1.6.0 milestone Jul 17, 2014
@iMichka iMichka added this to the 1.7.0 milestone Oct 13, 2014
@iMichka iMichka modified the milestones: 1.6.0, 1.7.0, 1.8.0 Feb 28, 2015
@iMichka
Copy link
Collaborator Author

iMichka commented Feb 28, 2015

Moving to 1.8.0; I need to add support for castxml first. The documentation cleanup will come later.

@iMichka iMichka removed this from the 1.8.0 milestone Aug 18, 2016
iMichka added a commit that referenced this issue Oct 9, 2016
@iMichka
Use sphinx-apidoc to generate the documentation automatically (#1)
a044c45
@iMichka iMichka added this to the 1.9.0 milestone Oct 9, 2016
@iMichka
Copy link
Collaborator Author

iMichka commented Oct 9, 2016

Done. I used sphinx-autodoc :)

@iMichka iMichka closed this as completed Oct 9, 2016
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@iMichka iMichka

Labels
documentation
Projects
None yet
Milestone
1.9.0
Development

No branches or pull requests
1 participant
@iMichka