Skip to content

Commit

Permalink
Fix documentation links (#1790)
Browse files Browse the repository at this point in the history
  • Loading branch information
brichet authored Jun 13, 2023
1 parent 1c1878d commit e42a93a
Show file tree
Hide file tree
Showing 9 changed files with 14 additions and 14 deletions.
2 changes: 1 addition & 1 deletion nbgrader/docs/make.bat
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ if errorlevel 9009 (
echo.may add the Sphinx directory to PATH.
echo.
echo.If you don't have Sphinx installed, grab it from
echo.http://www.sphinx-doc.org/en/master/
echo.https://www.sphinx-doc.org/en/master/
exit /b 1
)

Expand Down
2 changes: 1 addition & 1 deletion nbgrader/docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@
#
# This is also used if you do content translation via gettext catalogs.
# Usually you set "language" from the command line for these cases.
language = None
language = 'en'

# There are two options for replacing |today|: either, you set today to some
# non-false value, then it is used:
Expand Down
6 changes: 3 additions & 3 deletions nbgrader/docs/source/configuration/jupyterhub_config.rst
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ integrate with JupyterHub so that all grading can occur on the same server.
logfile so that you can more easily debug problems. To do so, you can set
a config option, for example ``NbGrader.logfile = "/usr/local/share/jupyter/nbgrader.log"``.

Each of these use cases also has a corresponding demo in the `demos folder <https://github.com/jupyter/nbgrader/tree/master/demos>`_ of the GitHub repository.
Each of these use cases also has a corresponding demo in the `demos folder <https://github.com/jupyter/nbgrader/tree/main/demos>`_ of the GitHub repository.

Example Use Case: One Class, One Grader
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Expand Down Expand Up @@ -68,7 +68,7 @@ Example Use Case: One Class, Multiple Graders
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

If you have multiple graders, then you can set up a `shared notebook server
<https://github.com/jupyterhub/jupyterhub/tree/master/examples/service-notebook>`_
<https://github.com/jupyterhub/jupyterhub/tree/main/examples/service-notebook>`_
as a JupyterHub service. I recommend creating a separate grader account (such
as ``grader-course101``) for this server to have access to.

Expand Down Expand Up @@ -189,7 +189,7 @@ JupyterHub Authentication

With the advent of JupyterHubAuthPlugin, nbgrader will ask JupyterHub which students are enrolled in which courses and only show them assignments from those respective courses (note that the ``JupyterHubAuthPlugin`` requires JupyterHub version 0.8 or higher). Similarly, nbgrader will ask JupyterHub which instructors have access to which courses and only show them formgrader links for those courses.

On the JupyterHub side of things, to differentiate student from instructor, groups need to be named ``formgrade-{course_id}`` for instructors and and grader accounts, and ``nbgrader-{course_id}`` for students. The course service additionally needs to have an API token set that is from a JupyterHub admin (see `JupyterHub documentation <https://jupyterhub.readthedocs.io/en/stable/reference/rest.html#create-an-api-token>`_).
On the JupyterHub side of things, to differentiate student from instructor, groups need to be named ``formgrade-{course_id}`` for instructors and and grader accounts, and ``nbgrader-{course_id}`` for students. The course service additionally needs to have an API token set that is from a JupyterHub admin (see `JupyterHub documentation <https://jupyterhub.readthedocs.io/en/stable/howto/rest.html#create-an-api-token>`_).

As in the case of multiple graders for a single class, if you have multiple
classes on the same JupyterHub instance, then you will need to create multiple
Expand Down
4 changes: 2 additions & 2 deletions nbgrader/docs/source/contributor_guide/database.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Modifying the Database
Sometimes new features require modifying the database, such as adding a new
column. Implementing such changes is fine, but can cause compatibility problems
for users who are using an older version of the database schema. To resolve
this issue, we use `alembic <https://alembic.zzzcomputing.com/en/latest/index.html>`_ to handle database migrations.
this issue, we use `alembic <https://alembic.sqlalchemy.org/en/latest/index.html>`_ to handle database migrations.

To use alembic to migrate the database schema, first run the following
command::
Expand All @@ -26,7 +26,7 @@ called ``extra_credit`` to the ``grade`` table:
op.drop_column('grade', 'extra_credit')
Please see the `alembic documentation
<https://alembic.zzzcomputing.com/en/latest/index.html>`_ for further details on
<https://alembic.sqlalchemy.org/en/latest/index.html>`_ for further details on
how these files work. Additionally, note that you both need to update the
database schema in ``nbgrader/api.py`` (this describes how to create **new**
databases) as well as using alembic to describe what changes need to be made to
Expand Down
4 changes: 2 additions & 2 deletions nbgrader/docs/source/contributor_guide/documentation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Editing source files
--------------------

* ReStructured Text: The rst files should be fairly straightforward to edit. Here is
`a quick reference of rst syntax <http://docutils.sourceforge.net/docs/user/rst/quickref.html>`_.
`a quick reference of rst syntax <https://docutils.sourceforge.io/docs/user/rst/quickref.html>`_.
Some of the rst files also use `Sphinx autodoc <https://www.sphinx-doc.org/en/master/usage/extensions/autodoc.html>`_.

* Jupyter Notebooks: The Jupyter notebooks are written in Python and should be written so that
Expand All @@ -36,7 +36,7 @@ While the documentation gets built automatically on Read The Docs, the notebooks
However, executing the notebooks is easy to do!

Our docs are built with `nbconvert <https://nbconvert.readthedocs.io/en/latest/>`_,
`Pandoc <https://pandoc.org/>`_, and `Sphinx <http://www.sphinx-doc.org/en/master/>`_.
`Pandoc <https://pandoc.org/>`_, and `Sphinx <https://www.sphinx-doc.org/en/master/>`_.
To build the docs locally, run the following command::

python tasks.py docs
Expand Down
2 changes: 1 addition & 1 deletion nbgrader/docs/source/contributor_guide/overview.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,4 @@ expectations are for contributions.

In general, the guidelines for opening issues, submitting PRs, code style,
testing, and documentation, are the same as the `IPython contribution
guidelines <https://github.com/ipython/ipython/blob/master/CONTRIBUTING.md>`_.
guidelines <https://github.com/ipython/ipython/blob/main/CONTRIBUTING.md>`_.
2 changes: 1 addition & 1 deletion nbgrader/docs/source/contributor_guide/pull_request.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Pull requests
Development workflow
--------------------
We follow the development workflow described in the `IPython contribution
guidelines <https://github.com/ipython/ipython/blob/master/CONTRIBUTING.md>`_
guidelines <https://github.com/ipython/ipython/blob/main/CONTRIBUTING.md>`_
and `IPython contributing wiki
<https://github.com/ipython/ipython/wiki/Dev:-GitHub-workflow>`_.

Expand Down
4 changes: 2 additions & 2 deletions nbgrader/docs/source/contributor_guide/releasing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ This list should then be included in the changelog.
Bump the version number
-----------------------

The version number is bumped using `tbump <https://github.com/dmerejkowsky/tbump>`_ :
The version number is bumped using `tbump <https://github.com/your-tools/tbump>`_ :
``tbump <VERSION> --no-push``

The version number should have been changed in the following files :
Expand Down Expand Up @@ -165,7 +165,7 @@ Change to development version
Bump the version again, this time to development. For example, if the release
was ``0.3.0``, then the new version should be ``0.4.0.dev``.

Use `tbump <https://github.com/dmerejkowsky/tbump>`_ again :
Use `tbump <https://github.com/your-tools/tbump>`_ again :
``tbump 0.4.0.dev --no-push`` (change the version number with the correct one)

As a reminder, the files concerned are :
Expand Down
2 changes: 1 addition & 1 deletion nbgrader/docs/source/plugins/zipcollect-plugin.rst
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ file should be skipped or a dictionary that, at the very least, contains the
)
For more information about named group regular expressions see
`<https://docs.python.org/howto/regex.html>`_
`<https://docs.python.org/3/howto/regex.html>`_

Note: ``file_id`` must contain the relative path to the assignment when
collecting submission files in assignment sub-folders, for example:
Expand Down

0 comments on commit e42a93a

Please sign in to comment.