Skip to content

Commit

Permalink
words
Browse files Browse the repository at this point in the history
  • Loading branch information
njsmith committed May 12, 2017
1 parent 022dfc8 commit abd966a
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 7 deletions.
6 changes: 3 additions & 3 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -32,9 +32,9 @@ https://github.com/python-trio/sphinxcontrib-trio
**Usage:** ``pip install -U sphinxcontrib-trio`` in the same
environment where you installed sphinx, and then add
``"sphinxcontrib_trio"`` to the list of ``extensions`` in your
project's ``conf.py``. (Note that it's ``sphinxcontrib_trio`` with an
underscore, NOT a dot. This is because I don't understand namespace
packages, and I fear things that I don't understand.)
project's ``conf.py``. (Notice that ``"sphinxcontrib_trio"`` has an
underscore in it, NOT a dot. This is because I don't understand
namespace packages, and I fear things that I don't understand.)

**Code of conduct:** Contributors are requested to follow our `code of
conduct
Expand Down
8 changes: 4 additions & 4 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ every possible type: ``asyncmethod::``, ``abstractmethod::``,
the idea. But this quickly becomes silly. sphinxcontrib-trio takes a
different approach: it enhances the basic ``function::`` and
``method::`` directives to accept options describing the attributes of
each function/method, so you can mix and match like:
each function/method, so you can write ReST code like:

.. code-block:: rst
Expand All @@ -32,7 +32,7 @@ each function/method, so you can mix and match like:
This method is perhaps more complicated than it needs to be.
and you'll get a rendered output like:
and you'll get rendered output like:

.. method:: overachiever(arg1, ...)
:abstractmethod:
Expand All @@ -41,7 +41,7 @@ and you'll get a rendered output like:

This method is perhaps more complicated than it needs to be.

And while I was at it, I also enhanced the ``sphinx.ext.autodoc``
While I was at it, I also enhanced the ``sphinx.ext.autodoc``
directives ``autofunction::`` and ``automethod::`` with new versions
that know how to automatically detect many of these attributes, so you
could just as easily have written the above as:
Expand All @@ -63,7 +63,7 @@ alias for:
and similarly ``staticmethod``, ``decorator``, and
``decoratormethod``, so dropping this extension into an existing
sphinx project should be 100% backwards-compatible while giving you
sphinx project should be 100% backwards-compatible while giving sphinx
new superpowers.

Basically, this is how sphinx ought to work in the first
Expand Down

0 comments on commit abd966a

Please sign in to comment.