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

adding autodocumentation for python and C++ #414

Merged
merged 5 commits into from
Feb 11, 2019
Merged

Conversation

timkpaine
Copy link
Member

@timkpaine timkpaine commented Feb 5, 2019

Framework for #384

Relies on doxygen to autogenerate C++ documentation, integrates it with sphinx and sphinx-apidoc python documentation using breathe. Can investigate a tool like sphinx-js for hooking in javascript as well.

Initial TODOs

  • add JSDoc config w/ babel support
  • fix sphinx-js bug with sphinx value iteration
  • hook in sphinx-js

@timkpaine timkpaine added documentation Improvements/bugs/changes to documentation C++ JS Python labels Feb 5, 2019
@timkpaine
Copy link
Member Author

mozilla/sphinx-js#94

@timkpaine
Copy link
Member Author

@texodus good to go, i'll flesh out the rest in a separate PR

@timkpaine
Copy link
Member Author

@JHawk @sc1f take a look, and start planning on writing docstrings accordingly

@timkpaine timkpaine changed the title [WIP] adding autodocumentation for python and C++ adding autodocumentation for python and C++ Feb 9, 2019
@texodus
Copy link
Member

texodus commented Feb 11, 2019

Thanks for the PR!

There are already full JSDoc strings for all public APIs. It would be nice if we could unify the docs across packages to output something consistent - I'd like to not have half of the docs in Github and half in readthedocs if possible. In the meantime, this is a strict improvement over the 0% python docs we currently publish.

@texodus texodus merged commit 815d12a into finos:master Feb 11, 2019
@timkpaine timkpaine deleted the docs branch February 12, 2019 17:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
C++ documentation Improvements/bugs/changes to documentation JS Python
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants