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.

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

Unify API Reference Structure #450

Open
2 tasks
JonathanWenger opened this issue Jul 2, 2021 · 0 comments
Open
2 tasks

Unify API Reference Structure #450

JonathanWenger opened this issue Jul 2, 2021 · 0 comments
Labels
documentation Improvements or additions to documentation improvement Improvements of existing functionality

Comments

@JonathanWenger
Copy link
Contributor

JonathanWenger commented Jul 2, 2021

Problem

With the new Sphinx template, the API Reference has lost some of its navigational structure, making it hard for users to understand the package structure.

Proposed Solution

Across all subpackages of ProbNum, ensure that

  • collapsing sidebar navigation exists for at least two levels probnum.subpackage.module
  • Solver components are grouped and named correctly
    Screenshot from 2021-07-02 11-29-47

ToDo

  • create folders in docs/source/api for each subpackage with submodules that should appear in the documentation
  • create .rst files with the corresponding automodapi directive
@JonathanWenger JonathanWenger added documentation Improvements or additions to documentation improvement Improvements of existing functionality labels Jul 2, 2021
@JonathanWenger JonathanWenger added this to the Initial Release milestone Jul 2, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation improvement Improvements of existing functionality
Projects
None yet
Development

No branches or pull requests

1 participant