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.

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

Add user guide and API documentation #3

Open
2 tasks
astrojuanlu opened this issue Feb 20, 2013 · 1 comment
Open
2 tasks

Add user guide and API documentation #3

astrojuanlu opened this issue Feb 20, 2013 · 1 comment
Labels
documentation
Milestone
0.2

Comments

@astrojuanlu
Copy link
Member

Most of the functions have proper docstrings but still I have to build the documentation, maybe using Sphinx and putting it in a separate gh-pages branch.

  • Generate API documentation
  • Write short user guide with links to examples
@jorgepiloto jorgepiloto mentioned this issue Mar 29, 2019
Merged
5 tasks
jorgepiloto pushed a commit that referenced this issue Apr 3, 2019
Merge pull request #28 from jorgepiloto/docs
898583f 
With this, docs are updated 😄 Before closing #3 I would like to include more examples in a future pull request 😄
@jorgepiloto
Copy link
Member

After #29 I was expecting this web https://aeropython.github.io/scikit-aero/ to show the sphinx_rdt_theme, however it is still using the old solar one

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation
Projects
None yet
Milestone
0.2
Development

No branches or pull requests
2 participants
@astrojuanlu @jorgepiloto