Skip to content

Fix docs build#2469

Merged
vfdev-5 merged 1 commit intopytorch:masterfrom
DevPranjal:fix-docs-build
Feb 16, 2022
Merged

Fix docs build#2469
vfdev-5 merged 1 commit intopytorch:masterfrom
DevPranjal:fix-docs-build

Conversation

@DevPranjal
Copy link
Copy Markdown
Contributor

@DevPranjal DevPranjal commented Feb 16, 2022

Fixes #2464

Description: After #2457, the docs builds failed due to mention of the new file (defaults.rst) in the master conf.py which is used to build docs for all other versions as well. For now, this PR skips the copy operation when the file is not found to make the conf.py compatible with other versions.

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 the docs label Feb 16, 2022
@DevPranjal DevPranjal mentioned this pull request Feb 16, 2022
Closed
@vfdev-5
Copy link
Copy Markdown
Collaborator

vfdev-5 commented Feb 16, 2022

@DevPranjal thanks for the fix ! Have you tried to build docs locally using sphinxversionning to ensure that everything is working ?

@DevPranjal
Copy link
Copy Markdown
Contributor Author

DevPranjal commented Feb 16, 2022

Yes, the docs were built for other versions as well, and the html files were running well!
There were some warnings that do not seem related to this PR:

/tmp/tmp9gd7uf6dsphinxcontrib_versioning/61b425286ba89092ba0390b9c2d5a26d3d579ef2/ignite/engine/engine.py:docstring of ignite.engine.engine.Engine:1: WARNING: duplicate object description of ignite.engine.engine.Engine, other instance in engine, use :noindex: for one of them

/tmp/tmp9gd7uf6dsphinxcontrib_versioning/5837b2d40ba8302e986a5a5115b734990cbe201b/ignite/handlers/checkpoint.py:docstring of ignite.handlers.checkpoint.ModelCheckpoint:55: WARNING: Block quote ends without a blank line; unexpected unindent.

/tmp/tmp9gd7uf6dsphinxcontrib_versioning/84b5d413b68cf0407cb7bd027bec194809a5db2c/docs/source/engine.rst:2: WARNING: Duplicate explicit target name: "pytorch documentation".

vfdev-5
vfdev-5 approved these changes Feb 16, 2022
View reviewed changes
Copy link
Copy Markdown
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.

LGTM, thanks a lot @DevPranjal !

@vfdev-5 vfdev-5 merged commit a591386 into pytorch:master Feb 16, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@vfdev-5 vfdev-5 vfdev-5 approved these changes

Assignees

No one assigned

Labels

docs

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Fix docs building

2 participants

@DevPranjal @vfdev-5