-
Notifications
You must be signed in to change notification settings - Fork 225
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
Build Sphinx documentation and host on ReadTheDocs #211
Comments
I'm not familiar with sphing, how would that work. Once it's done, will the docs on reaththedocs automatically change? Do I need to setup some hooks on this repo or I need to reload something when I publish new releases? I'm all for having better/nicer documentation, but before deciding I'd like to know if it also implies some additional complexities/work for me in the future :) |
Yes, building and publishing docs would be automatic. It does require a hook for ReadTheDocs, but the rest is just code & config. After setup, there isn't much maintenance required. The main pieces are:
I can contribute the Sphinx config, so all you need to do is step 4. You can also add a ReadTheDocs badge to your README, if you'd like. |
Done. Check out PR #212. |
It would be helpful to have HTML documentation for
gpxpy
. It appears that the source code is the main source of documentation currently.Since
gpxpy
already has type annotations and some docstrings, it would be fairly simple to usesphinx-apidoc
andsphinx-autodoc-typehints
to generate HTML docs using the information that's already present.I would be willing to set this up, if you'd be open to a PR for this.
The text was updated successfully, but these errors were encountered: