File tree Expand file tree Collapse file tree 1 file changed +35
-0
lines changed Expand file tree Collapse file tree 1 file changed +35
-0
lines changed Original file line number Diff line number Diff line change @@ -40,6 +40,41 @@ as Sphinx Lint works line by line it will inevitably think the `:meth:` role is
4040To avoid false positives, some rules are skipped if we're in a table.
4141
4242
43+ ## Contributing
44+
45+ A quick way to test if some syntax is valid from a pure
46+ reStructuredText point of view, one case use ` docutils ` 's ` pseudoxml `
47+ writer, like:
48+
49+ ``` text
50+ $ docutils --writer=pseudoxml tests/fixtures/xpass/role-in-code-sample.rst
51+ <document source="tests/fixtures/xpass/role-in-code-sample.rst">
52+ <paragraph>
53+ Found in the pandas documentation, this is valid:
54+ <bullet_list bullet="*">
55+ <list_item>
56+ <paragraph>
57+ A pandas class (in the form
58+ <literal>
59+ :class:`pandas.Series`
60+ )
61+ <list_item>
62+ <paragraph>
63+ A pandas method (in the form
64+ <literal>
65+ :meth:`pandas.Series.sum`
66+ )
67+ <list_item>
68+ <paragraph>
69+ A pandas function (in the form
70+ <literal>
71+ :func:`pandas.to_datetime`
72+ )
73+ <paragraph>
74+ it's documenting roles using code samples (double backticks).
75+ ```
76+
77+
4378## Releasing
4479
4580First test with friends projects by running:
You can’t perform that action at this time.
0 commit comments