pytorch-lightning icon indicating copy to clipboard operation
pytorch-lightning copied to clipboard

Changes to try an make the gen work

Open Felonious-Spellfire opened this issue 2 years ago • 2 comments

What does this PR do?

Attempt to get PL doc generation to work on Windows.

I made changes to the config.py file, index.rst file and changed the location of the _notebooks folder.

On my local machine I also installed Pandoc.

Fixes #<issue_number>

Does your PR introduce any breaking changes? If yes, please list them.

PL docs will likely not generate properly

Before submitting

  • [ ] Was this discussed/approved via a GitHub issue? (not for typos and docs)
  • [ ] Did you read the contributor guideline, Pull Request section?
  • [ ] Did you make sure your PR does only one thing, instead of bundling different changes together?
  • [X] Did you make sure to update the documentation with your changes? (if necessary)
  • [ ] Did you write any new necessary tests? (not for typos and docs)
  • [ ] Did you verify new and existing tests pass locally with your changes?
  • [ ] Did you list all the breaking changes introduced by this pull request?
  • [ ] Did you update the CHANGELOG? (not for typos, docs, test updates, or minor internal changes/refactors)

PR review

  • [ ] Is this pull request ready for review? (if not, please submit in draft mode)
  • [ ] Check that all items from Before submitting are resolved
  • [ ] Make sure the title is self-explanatory and the description concisely explains the PR
  • [ ] Add labels and milestones (and optionally projects) to the PR so it can be classified

Did you have fun?

Make sure you had fun coding 🙃

Felonious-Spellfire avatar Aug 04 '22 16:08 Felonious-Spellfire

Is removing all tutorials (notebooks) intentional and if yes, where else shall we publish our work?

No, we won't remove them. I'll put a note somewhere that states that Windows will not generate the tutorials properly.

Felonious-Spellfire avatar Aug 16 '22 19:08 Felonious-Spellfire

This pull request has been automatically marked as stale because it has not had recent activity. It will be closed in 7 days if no further activity occurs. If you need further help see our docs: https://pytorch-lightning.readthedocs.io/en/latest/generated/CONTRIBUTING.html#pull-request or ask the assistance of a core contributor here or on Slack. Thank you for your contributions.

stale[bot] avatar Sep 20 '22 21:09 stale[bot]

This pull request is going to be closed. Please feel free to reopen it create a new from the actual master.

stale[bot] avatar Oct 01 '22 18:10 stale[bot]