Update 'Develop and Build Documentation' with new instructions #3616
Conversation
|
|
|
@supriyakhandekar volunteered to review this |
| ``` | ||
|
|
||
| 4. Open the documentation from the build directory: `docs/build/html` | ||
| To build the ipywidgets documentation see the instructions available on - [Jupyter Widgets - Develop and Build Documentation](https://ipywidgets.readthedocs.io/en/latest/dev_install.html) |
There was a problem hiding this comment.
Is this what we want to provide a link to? Seems like the instructions in the dev_docs.md are mirroring the original readme here.
There was a problem hiding this comment.
Instructions in the readme were removed so that we would not have to maintain two different sets of the same instructions on both the readme and the ipywidgets.readthedocs.io, but i can add back the readme instructions as well
There was a problem hiding this comment.
It makes sense to maintain one set of instructions however it seems that the instructions here https://ipywidgets.readthedocs.io/en/latest/dev_install.html is for the dev install of ipywidgets, not specifically for documentation. And if we were to link https://ipywidgets.readthedocs.io/en/latest/dev_docs.html instead, this seems to be different set of instructions from the README instructions that you updated
PR Summary: