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

Improve doc examples rendering #2114

Closed
KickItLikeShika opened this issue Jul 16, 2021 · 4 comments · Fixed by #2216, #2217 or #2222
Closed

Improve doc examples rendering #2114

KickItLikeShika opened this issue Jul 16, 2021 · 4 comments · Fixed by #2216, #2217 or #2222

Comments

@KickItLikeShika
Copy link
Contributor

KickItLikeShika commented Jul 16, 2021

Currently we are rendering our examples in the docs like this https://pytorch.org/ignite/generated/ignite.engine.engine.Engine.html#ignite.engine.engine.Engine which is not very neat.
What we want to do is to find a better way to make it more good looking, and update our docs examples

image

  • Replace "Examples" with some sphinx tag or something else, for example, like scikit-image does:

image

@Ketan-Kapse
Copy link

Hi @KickItLikeShika, I'm interested in working on this issue! It would be my very first contribution.

@KickItLikeShika
Copy link
Contributor Author

KickItLikeShika commented Aug 17, 2021

Hi @Ketan-Kapse, thanks a lot for showing interest! You're welcome to send PRs to tackle this. The PR description gives some context about what should be done, also if needed help, you can ask in our Discord server https://discord.com/invite/djZtm3EmKj

@FarehaNousheen
Copy link
Contributor

Hi, I'm not clear about the suggested ways of improving the doc. Kindly guide me on this so that I can proceed ahead in improvising this.

@KickItLikeShika
Copy link
Contributor Author

Hi @FarehaNousheen, you can see here how we render examples #2114, if you're familiar with Sphinx, we are using Sphinx to create our docs: https://www.sphinx-doc.org/en/master/. We would like to change the way we render our examples, we left a suggestions in the description of the issue, if you have another idea to render our docs we can discuss it here.
For the idea in the description you can check how scikit-learn does that in their codebase, and replicate it here.

vfdev-5 added a commit that referenced this issue Sep 26, 2021
* fix #2114: make doc subsections header bold

* addressing proposed changes

Co-authored-by: vfdev <[email protected]>
vfdev-5 added a commit that referenced this issue Sep 27, 2021
)

* reformat docstrings in the 'distributed' folder

* fix code formatting

Co-authored-by: vfdev <[email protected]>
vfdev-5 added a commit that referenced this issue Sep 28, 2021
* fix #2114: reformat docstrings in the 'engine' folder

* fix code formatting

Co-authored-by: vfdev <[email protected]>
vfdev-5 added a commit that referenced this issue Sep 28, 2021
* fix #2114: reformat docstrings in the 'handlers' folder

* fix 'examples' in Checkpoint.load_objects docs

Co-authored-by: vfdev <[email protected]>
sdesrozis pushed a commit that referenced this issue Sep 28, 2021
* fix #2114: reformat docstrings in the 'metrics' folder

* fix linter warning

* move code example back to description
sdesrozis added a commit that referenced this issue Sep 28, 2021
* fix #2114: reformat docstrings in the 'contrib' folder

* remove unused *_ from ClearMLLogger.__init__

Co-authored-by: Sylvain Desroziers <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment