-
-
Notifications
You must be signed in to change notification settings - Fork 610
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
Comments
Hi @KickItLikeShika, I'm interested in working on this issue! It would be my very first contribution. |
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 |
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. |
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. |
* fix #2114: make doc subsections header bold * addressing proposed changes Co-authored-by: vfdev <[email protected]>
) * reformat docstrings in the 'distributed' folder * fix code formatting Co-authored-by: vfdev <[email protected]>
* fix #2114: reformat docstrings in the 'engine' folder * fix code formatting Co-authored-by: vfdev <[email protected]>
* fix #2114: reformat docstrings in the 'handlers' folder * fix 'examples' in Checkpoint.load_objects docs Co-authored-by: vfdev <[email protected]>
* fix #2114: reformat docstrings in the 'metrics' folder * fix linter warning * move code example back to description
* fix #2114: reformat docstrings in the 'contrib' folder * remove unused *_ from ClearMLLogger.__init__ Co-authored-by: Sylvain Desroziers <[email protected]>
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
The text was updated successfully, but these errors were encountered: