Skip to content

Commit

Permalink
Link and Docs Update (#290)
Browse files Browse the repository at this point in the history
* update link for check_release link_check

* move known issues section to nbclassic page for visibility
  • Loading branch information
RRosio authored Sep 7, 2024
1 parent 1ceae32 commit b8eff7d
Show file tree
Hide file tree
Showing 3 changed files with 17 additions and 18 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -134,7 +134,7 @@
"\n",
"> Of course, in addition to the files listed, there are number of other files one needs to build a proper package. Here are some good resources:\n",
"- [The Hitchhiker's Guide to Packaging](https://the-hitchhikers-guide-to-packaging.readthedocs.io/en/latest/quickstart.html)\n",
"- [Repository Structure and Python](https://kenreitz.org/essays/2013/01/27/repository-structure-and-python) by Kenneth Reitz\n",
"- [Repository Structure and Python](https://kennethreitz.org/essays/2013/repository_structure_and_python) by Kenneth Reitz\n",
"\n",
"> How you distribute them, too, is important:\n",
"- [Packaging and Distributing Projects](https://python-packaging-user-guide.readthedocs.io/tutorials/distributing-packages/)\n",
Expand Down
16 changes: 16 additions & 0 deletions docs/source/nbclassic.rst
Original file line number Diff line number Diff line change
Expand Up @@ -90,3 +90,19 @@ if available at the `Jupyterlab-contrib website <https://jupyterlab-contrib.gith

.. _JEP #79: https://jupyter.org/enhancement-proposals/79-notebook-v7/notebook-v7.html

Known issues
------------

Bellow are some known bugs and issues with the NbClassic project. These are items that may be of particular interest to users
migrating from notebook to nbclassic.

1. `#140 Error using jupyter_nbextensions_configurator with nbclassic <https://github.com/jupyter/nbclassic/issues/140>`_ is a
known issue with partial fix `Support nbclassic while updating the static path <https://github.com/Jupyter-contrib/jupyter_nbextensions_configurator/pull/141>`_
pending to be merged into the `Jupyter-contrib/jupyter_nbextensions_configurator <https://github.com/Jupyter-contrib/jupyter_nbextensions_configurator>`_ repository.

Once a release with this fix is available, users will be able to activate the extension with the following commands::

$ pip install 'jupyter_nbextensions_configurator @ git+https://github.com/datalayer-externals/jupyter-notebook-configurator.git@fix/nbclassic#egg=jupyter_nbextensions_configurator'
$ jupyter nbclassic-extension install --sys-prefix --py jupyter_nbextensions_configurator --overwrite
$ jupyter nbclassic-extension enable --sys-prefix --py jupyter_nbextensions_configurator
$ jupyter nbclassic-serverextension enable --sys-prefix --py jupyter_nbextensions_configurator
17 changes: 0 additions & 17 deletions docs/source/nbclassic_dev_faq.rst
Original file line number Diff line number Diff line change
Expand Up @@ -72,20 +72,3 @@ NbClassic Developer FAQ
.. _`allowed organization list`: https://github.com/MeeseeksBox/MeeseeksDev/blob/master/meeseeksdev/__init__.py#L26
.. _`Jupyter Community`: https://jupyter.org/community


Known issues
------------

Bellow are some known bugs and issues with the NbClassic project. These are items that may be of particular interest to users
migrating from notebook to nbclassic.

1. `#140 Error using jupyter_nbextensions_configurator with nbclassic <https://github.com/jupyter/nbclassic/issues/140>`_ is a
known issue with partial fix `Support nbclassic while updating the static path <https://github.com/Jupyter-contrib/jupyter_nbextensions_configurator/pull/141>`_
pending to be merged into the `Jupyter-contrib/jupyter_nbextensions_configurator <https://github.com/Jupyter-contrib/jupyter_nbextensions_configurator>`_ repository.

Once a release with this fix is available, users will be able to activate the extension with the following commands::

$ pip install 'jupyter_nbextensions_configurator @ git+https://github.com/datalayer-externals/jupyter-notebook-configurator.git@fix/nbclassic#egg=jupyter_nbextensions_configurator'
$ jupyter nbclassic-extension install --sys-prefix --py jupyter_nbextensions_configurator --overwrite
$ jupyter nbclassic-extension enable --sys-prefix --py jupyter_nbextensions_configurator
$ jupyter nbclassic-serverextension enable --sys-prefix --py jupyter_nbextensions_configurator

0 comments on commit b8eff7d

Please sign in to comment.