Skip to content

Conversation

DevPranjal
Copy link
Contributor

Fixes #2436

Description: Added toggles for default setup in docs to avoid confusion

Check list:

  • New tests are added (if a new feature is added)
  • New doc strings: description and/or example code are in RST format
  • Documentation is updated (if required)

@github-actions github-actions bot added docs module: contrib Contrib module module: handlers Core Handlers module module: metrics Metrics module labels Feb 9, 2022
@vfdev-5
Copy link
Collaborator

vfdev-5 commented Feb 9, 2022

@DevPranjal there is a warning that makes docs build to fail:

/home/runner/work/ignite/ignite/docs/source/defaults.rst: WARNING: document isn't included in any toctree

I haven't that warning when built locally

@DevPranjal
Copy link
Contributor Author

@DevPranjal there is a warning that makes docs build to fail
I haven't that warning when built locally

I had the warning locally too, but the built docs were displaying fine. After searching, I have added the :orphan: metadata tag on top in defaults.rst

@DevPranjal
Copy link
Contributor Author

@vfdev-5 I have edited the files as discussed to fix the problems with :orphan: tag.

Copy link
Collaborator

@vfdev-5 vfdev-5 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks a lot @DevPranjal , looks great !
Just a small question and we are good to go

@vfdev-5
Copy link
Collaborator

vfdev-5 commented Feb 10, 2022

@DevPranjal can you please fetch the latest commit from your fork to your local repository (and thus have 1341dff commit) and make an empty commit with amend (just git commit --amend) and push force to your fork such that we can restart the CI and autopep 8 will have nothing to fix in terms of code formatting. Currently the latest commit does not run doctests. Thanks

@vfdev-5 vfdev-5 merged commit 295f93b into pytorch:master Feb 10, 2022
@DevPranjal DevPranjal deleted the toggle-for-docs branch February 11, 2022 02:13
@vfdev-5 vfdev-5 mentioned this pull request Feb 14, 2022
@DevPranjal DevPranjal mentioned this pull request Feb 16, 2022
3 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs module: contrib Contrib module module: handlers Core Handlers module module: metrics Metrics module
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[doctest] Provide definition of default_evaluator and other default objects
2 participants