Skip to content

Commit

Permalink
Fixing broken doc links (#1457)
Browse files Browse the repository at this point in the history
* fix broken links

* fix typo
  • Loading branch information
Skaft authored May 3, 2021
1 parent a2850c7 commit bbe113e
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 5 deletions.
6 changes: 3 additions & 3 deletions docs/source/contributing/documentation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -116,7 +116,7 @@ This includes:

1. The usage of ``Attributes`` to specify ALL ATTRIBUTES that a
class can have, their respective types, and a brief (or long, if
needed) description. (See more on :ref:`_types`)
needed) description. (See more on :ref:`types<types>`)

Also, ``__init__`` parameters should be specified as ``Parameters`` **on
the class docstring**, *rather than under* ``__init__``. Note that this
Expand Down Expand Up @@ -266,8 +266,8 @@ Example:
.. _types:

Reference to types in documentaion
----------------------------------
Reference to types in documentation
-----------------------------------

Always specify types with the correct **role** (see
https://www.sphinx-doc.org/en/1.7/domains.html#python-roles) for the
Expand Down
4 changes: 2 additions & 2 deletions docs/source/installation/for_dev.rst
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,7 @@ command ``pytest`` to run the tests.
.. important::

You should always run the test suite before making a PR. See
:doc:`contributing` for details.
:doc:`../contributing` for details.


Code Formatting and Linting Using Poetry
Expand Down Expand Up @@ -145,5 +145,5 @@ For Developers with pip
python3 -m pip install .
Please see :doc:`contributing` for more details about contributing to Manim.
Please see :doc:`../contributing` for more details about contributing to Manim.
Since `pip` doesn't implement editable installations from our pyproject.toml

0 comments on commit bbe113e

Please sign in to comment.