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

Autoapi issues #341

Open
surgura opened this issue Oct 23, 2023 · 0 comments
Open

Autoapi issues #341

surgura opened this issue Oct 23, 2023 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@surgura
Copy link
Contributor

surgura commented Oct 23, 2023

  • revolve and simulators namespace packages are not displayed; instead all packages are listed side by side.
  • Subpackages and submodules are displayed but this clutters the side menu.
  • References to other Revolve2 packages do not have a proper link. (see maybe Intersphinx?)
  • References to types do not always refer to the where the type is explicitly exported in all and instead refer to private _file.py. See e.g. function signatures.
@surgura surgura added the documentation Improvements or additions to documentation label Oct 23, 2023
@surgura surgura mentioned this issue Oct 23, 2023
Merged
surgura added a commit that referenced this issue Oct 23, 2023
@surgura
169 improve apidoc generation (#342)
161cdf1 
* Remove autodoc and apidoc in favor of autoapi.
* No need to manually edit api documentation ever again.
* Display not perfect but reasonable for now. See #341
surgura added a commit that referenced this issue Oct 31, 2023
@surgura
169 improve apidoc generation (#342)
d2d9dda 
* Remove autodoc and apidoc in favor of autoapi.
* No need to manually edit api documentation ever again.
* Display not perfect but reasonable for now. See #341
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@surgura