diff --git a/README.md b/README.md index aaf1173ef..0cca15ce5 100644 --- a/README.md +++ b/README.md @@ -40,6 +40,41 @@ as Sphinx Lint works line by line it will inevitably think the `:meth:` role is To avoid false positives, some rules are skipped if we're in a table. +## Contributing + +A quick way to test if some syntax is valid from a pure +reStructuredText point of view, one case use `docutils`'s `pseudoxml` +writer, like: + +```text +$ docutils --writer=pseudoxml tests/fixtures/xpass/role-in-code-sample.rst + + + Found in the pandas documentation, this is valid: + + + + A pandas class (in the form + + :class:`pandas.Series` + ) + + + A pandas method (in the form + + :meth:`pandas.Series.sum` + ) + + + A pandas function (in the form + + :func:`pandas.to_datetime` + ) + + it's documenting roles using code samples (double backticks). +``` + + ## Releasing First test with friends projects by running: