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

Documenation of APIs is not correct #201

Closed
gromdimon opened this issue Nov 10, 2023 · 1 comment · Fixed by #202
Closed

Documenation of APIs is not correct #201

gromdimon opened this issue Nov 10, 2023 · 1 comment · Fixed by #202
Labels
bug Something isn't working
Milestone
0.2.0

Comments

@gromdimon
Copy link
Contributor

Describe the bug
The documentation at https://reev.readthedocs.io/ is not correct at the api part.

To Reproduce
Steps to reproduce the behavior:

  1. Go to https://reev.readthedocs.io/en/latest/api_models.html#app-models-adminmsg
  2. Encounter bug

Expected behavior
All functions should be properly documented

Screenshots
image

Desktop (please complete the following information):
N/A

Smartphone (please complete the following information):
N/A

Additional context
Probably the problem is in module names resolution
@gromdimon gromdimon added the bug Something isn't working label Nov 10, 2023
@gromdimon gromdimon added this to the 0.2.0 milestone Nov 10, 2023
@gromdimon gromdimon linked a pull request Nov 13, 2023 that will close this issue
fix: Docs are rendered properly (#201) #202
Merged
gromdimon added a commit that referenced this issue Nov 13, 2023
@gromdimon
fix: Docs are rendered properly (#201) (#202)
2119aa6
@varfish-bot varfish-bot mentioned this issue Nov 13, 2023
Merged
@gromdimon
Copy link
Contributor Author

Since no changes occured at https://reev.readthedocs.io/en/latest/ I reopen the issue

@gromdimon gromdimon reopened this Nov 13, 2023
gromdimon added a commit that referenced this issue Nov 13, 2023
@gromdimon
fix: Documentation of APIs (#201) (#206)
fe56f4a
gromdimon added a commit that referenced this issue Nov 13, 2023
@gromdimon
fix: Fix documentation in production (#201) (#207)
6973d0e
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
bug Something isn't working
Projects
None yet
Milestone
0.2.0
Development

Successfully merging a pull request may close this issue.

fix: Docs are rendered properly (#201) bihealth/reev
1 participant
@gromdimon