Skip to content

Fix API documentation #310

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
tomschr opened this issue Nov 3, 2020 · 0 comments · Fixed by #311
Closed

Fix API documentation #310

tomschr opened this issue Nov 3, 2020 · 0 comments · Fixed by #311
Assignees
@tomschr
Labels
Bug Error, flaw or fault to produce incorrect or unexpected results Doc Documentation related issue

Comments

@tomschr
Copy link
Member

tomschr commented Nov 3, 2020

Situation

The API documentation is empty, although there is code to add that.

Proposed Solution

It seems generating the API documentation by calling a script is a bit fragile on ReadTheDocs. Maybe a more "semi-manual" approach would be more useful.
@tomschr tomschr added Bug Error, flaw or fault to produce incorrect or unexpected results Doc Documentation related issue labels Nov 3, 2020
@tomschr tomschr self-assigned this Nov 3, 2020
tomschr added a commit to tomschr/python-semver that referenced this issue Nov 3, 2020
@tomschr
Fix python-semver#310: Correct API documentation
b965788 
* Remove all automatic generation and use a more
  "semi-manual" approach (gives more control)
* Improve docstrings in semver module
* Remove docstrings in some dunder methods; Sphinx
  and autodoc uses the docstring from the parent class
* Remove sphinx-apidoc command from :file:`tox.ini`
@tomschr tomschr mentioned this issue Nov 3, 2020
Merged
tomschr added a commit to tomschr/python-semver that referenced this issue Nov 3, 2020
@tomschr
Fix python-semver#310: Correct API documentation
dcdcd2a 
* Remove all automatic generation and use a more
  "semi-manual" approach (gives more control)
* Improve docstrings in semver module
* Remove docstrings in some dunder methods; Sphinx
  and autodoc uses the docstring from the parent class
* Remove sphinx-apidoc command from :file:`tox.ini`
tomschr added a commit that referenced this issue Nov 4, 2020
@tomschr
Merge pull request #311 from tomschr/bugfix/310-api-doc
073e314 
Fix #310: Correct API documentation
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@tomschr tomschr

Labels
Bug Error, flaw or fault to produce incorrect or unexpected results Doc Documentation related issue
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Fix #310: Correct API documentation tomschr/python-semver
1 participant
@tomschr