Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updating documentation for nbclassic #134

Merged
merged 25 commits into from
Sep 14, 2022
Merged

Updating documentation for nbclassic #134

merged 25 commits into from
Sep 14, 2022

Conversation

RRosio
Copy link
Collaborator

@RRosio RRosio commented Jul 27, 2022

Update readthedocs documentation WIP.

Work TBD:

  • Update homepage outline of documentation
  • Update development faq
  • Delete that documentation which is not applicable to nbclassic(?)

@RRosio RRosio added the documentation Improvements or additions to documentation label Jul 27, 2022
docs/source/conf.py Outdated Show resolved Hide resolved
docs/source/index.rst Outdated Show resolved Hide resolved

NbClassic in the Jupyter Ecosystem
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Copy link
Member

Choose a reason for hiding this comment

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

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Okay awesome! Thank you for the link, I will add it to the documentation too!

docs/source/nbclassic.rst Outdated Show resolved Hide resolved
RRosio and others added 2 commits August 17, 2022 10:06
@echarles
Copy link
Member

@RRosio Please confirm when you'd like me to review this PR.

As discussed, you could add a page/section which highlights things people migrating form notebook to nbclassic should know or care about;

For example, #140 depends Jupyter-contrib/jupyter_nbextensions_configurator#141. Once Jupyter-contrib/jupyter_nbextensions_configurator#141 will be merged and released, users will need to run the following command to activate the extension

pip install jupyter_nbextensions_configurator
jupyter nbextension install --sys-prefix --py jupyter_nbextensions_configurator --overwrite
jupyter nbextension enable --sys-prefix --py jupyter_nbextensions_configurator
jupyter serverextension install --sys-prefix --py jupyter_nbextensions_configurator --overwrite
jupyter serverextension enable --sys-prefix --py jupyter_nbextensions_configurator

@RRosio RRosio marked this pull request as ready for review September 13, 2022 14:14
@RRosio
Copy link
Collaborator Author

RRosio commented Sep 13, 2022

I did some reordering of sections here for readability and added a section for known issues. The Test Downstream job is failing but I opened another PR with a minimal change and it was still failing which leads me to think that the fail is not related to the changes in the PR.

Copy link
Member

@echarles echarles left a comment

Choose a reason for hiding this comment

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

LGTM Thx @RRosio

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants