Skip to content

Commit 72e6a24

Browse files
committed
Minor front-page improvements
1 parent adf50fc commit 72e6a24

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

docs/index.rst

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,11 +13,13 @@ This package is intended to bring API documentation for rust crates to Sphinx:
1313

1414
- Auto-analysis of Rust crates, with minimal steps required to get started
1515

16-
- Auto-documentation of Rust crates: the documentation is generated to closely mirror the format of https://docs.rs
16+
- Cleanly documented APIs;
17+
the documentation is generated to closely mirror the format of https://docs.rs
1718

18-
- Integrates with sphinx cross-referencing system and :external:doc:`intersphinx <usage/extensions/intersphinx>` indexing
19+
- Integrates with the Sphinx cross-referencing system and
20+
:external:doc:`intersphinx <usage/extensions/intersphinx>` indexing.
1921

20-
- Supports writing docstrings for any valid Sphinx parser (reStructuredText, MyST markdown, etc.)
22+
- Supports writing docstrings for any valid Sphinx parser (reStructuredText, MyST markdown, ...)
2123

2224
Installation
2325
------------

0 commit comments

Comments
 (0)