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

fix code display in API refs and add link to source code #1389

Open
janfb opened this issue Feb 17, 2025 · 0 comments
Open

fix code display in API refs and add link to source code #1389

janfb opened this issue Feb 17, 2025 · 0 comments
Labels
documentation Improvements or additions to documentation hackathon
Milestone
curate issues for...

Comments

@janfb
Copy link
Contributor

janfb commented Feb 17, 2025

Our API Refs are cluttered and difficult to navigate. To fix this we should

  1. have a look at the documentation of https://github.com/mkdocstrings/mkdocstrings or similar plugins to improve the API reference setup
  2. find a way to link directly to the corresponding source code.

See also openjournals/joss-reviews#7754 (comment) for context.
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 hackathon
Projects
None yet
Milestone
curate issues for hackathon 2025
Development

No branches or pull requests
1 participant
@janfb