Skip to content

Commit

Permalink
Starting a contributing section
Browse files Browse the repository at this point in the history
  • Loading branch information
JulienPalard committed Apr 14, 2023
1 parent d9d5ab4 commit 33df562
Showing 1 changed file with 35 additions and 0 deletions.
35 changes: 35 additions & 0 deletions README.md
Expand Up @@ -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
<document source="tests/fixtures/xpass/role-in-code-sample.rst">
<paragraph>
Found in the pandas documentation, this is valid:
<bullet_list bullet="*">
<list_item>
<paragraph>
A pandas class (in the form
<literal>
:class:`pandas.Series`
)
<list_item>
<paragraph>
A pandas method (in the form
<literal>
:meth:`pandas.Series.sum`
)
<list_item>
<paragraph>
A pandas function (in the form
<literal>
:func:`pandas.to_datetime`
)
<paragraph>
it's documenting roles using code samples (double backticks).
```


## Releasing

First test with friends projects by running:
Expand Down

0 comments on commit 33df562

Please sign in to comment.