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

DOCS: improved documentation #146

Closed
antoinecollet5 opened this issue Sep 20, 2023 · 3 comments
Closed

DOCS: improved documentation #146

antoinecollet5 opened this issue Sep 20, 2023 · 3 comments

Comments

@antoinecollet5
Copy link
Contributor

What I propose to get a better documentation:

  • Use the pydata template instead of rst: looks more modern and has a dark mode.
  • Include the readme in the doc for a nice rendering and avoid duplication
  • Make links between the bibliography and the docstrings using the :cite: directive.
  • Better API section relying on autosummary
@tommyod
Copy link
Collaborator

tommyod commented Oct 2, 2023

@antoinecollet5 I'm very excited about these proposed changes. Seems like a no-brainer. Please do create or (or several) PRs. Better to create several small PRs than one large PR :)

@antoinecollet5
Copy link
Contributor Author

antoinecollet5 commented Oct 3, 2023 •
edited
Loading

@tommyod Ok I wait for the other PR to be merged (#149) !

@tommyod
Copy link
Collaborator

tommyod commented Oct 23, 2023

This was closed by #155

@tommyod tommyod closed this as completed Oct 23, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@tommyod @antoinecollet5