Skip to content

Docs improvements tracker and ReadTheDocs warnings #1983

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

Open
2 of 5 tasks
echedey-ls opened this issue Mar 5, 2024 · 0 comments
Open
2 of 5 tasks

Docs improvements tracker and ReadTheDocs warnings #1983

echedey-ls opened this issue Mar 5, 2024 · 0 comments

Comments

@echedey-ls
Copy link
Contributor

echedey-ls commented Mar 5, 2024

In the hope this issue becomes something like a tracker of small enhancements that can be done to the docs. Feel free to comment anything you spotted but were unsure if an issue was the right choice.

From my experience, these are some possible good first contributions to start learning the Sphinx environment:

  • The first line description of this FAQ section can make use of a :py:mod: role to link to the iotools module.

For the veterans preferably:

I will add more finds as I see them.

@echedey-ls echedey-ls changed the title Docs improvements (tracker) Docs improvements tracker and ReadTheDocs warnings Apr 4, 2024
@echedey-ls echedey-ls mentioned this issue May 1, 2024
4 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants