update org paths & convert logos #685
Conversation
|
@williamFalcon how is the documentation deployment, what will be the new path? |
|
it also fixes formating issues... |
|
@williamFalcon if seems that all bots are lost, can you add WIP bot... |
not sure. what do you suggest? |
| 'github': 'https://github.com/PyTorchLightning/pytorch-lightning', | ||
| 'github_issues': 'https://github.com/PyTorchLightning/pytorch-lightning/issues', | ||
| 'contributing': 'https://github.com/PyTorchLightning/pytorch-lightning/blob/master/CONTRIBUTING.md', | ||
| 'docs': 'https://PyTorchLightning.github.io/pytorch-lightning', |
There was a problem hiding this comment.
@williamFalcon this path/URL and the following linking specific section in new documentation...
Do you run it on readthecocs.org right?
README.md
Outdated
| @@ -274,77 +274,77 @@ Lightning also adds a text column with all the hyperparameters for this experime | |||
|
|
|||
|  | |||
|
|
|||
| ## Lightning automates all of the following ([each is also configurable](https://williamfalcon.github.io/pytorch-lightning/Trainer/)): | |||
| ## Lightning automates all of the following ([each is also configurable](https://PyTorchLightning.github.io/pytorch-lightning/Trainer/)): | |||
There was a problem hiding this comment.
all the following links shall be revisited according newly generated docs...
There was a problem hiding this comment.
quite a number of links are referring just a single line in docs so I would skip them and if needed just list the topic on the page... @williamFalcon ?
There was a problem hiding this comment.
What are you referring to exactly @Borda? Only one link per page? And not linking to each section fragment?
If so, i'd agree with this. When joining this project I was pretty overwhelmed with how many links there were. I opened them all to start reading, then realized most pages are the same.
Alternatively, if we were having links to all sections - I think the sections in the Readme should align with the sections in the docs. E.g. Training Loop should only have the Training Loop page links underneath.
There was a problem hiding this comment.
that was my thoughts, have links only to major section and alternatively add examples/notebooks where the particular applications are explained...
I would say to keep the version of the last docs on your personal URL - https://PyTorchLightning.github.io/pytorch-lightning @PyTorchLightning/core-contributors any other suggestion? |
|
the live docs is available here - https://torch-lightning.readthedocs.io/en/paths/ @PyTorchLightning/core-contributors ^^ |
|
waiting for #687 8-) |
|
@PyTorchLightning/core-contributors ^^ |
|
@Borda rebase master into this PR? |
|
sure, just do not have internet for the weekend so I will finish it on Monday... |
|
final address is this one: https://pytorchlightning.github.io/pytorch-lightning |
|
@williamFalcon updated... |
|
as discussed on slack, lets use as docs path this one for now... https://pytorch-lightning.rtfd.io |
|
@williamFalcon @neggert can we move this forward? |
What does this PR do?
Fixes #683. Updating paths according to the recent move to the organisation... #604
PR review
Anyone in the community is free to review the PR once the tests have passed.
If we didn't discuss your PR in Github issues there's a high chance it will not be merged.