Skip to content

Commit e770fad

Browse files
committed
Add PyPI badge
1 parent b597351 commit e770fad

File tree

3 files changed

+18
-2
lines changed

3 files changed

+18
-2
lines changed

README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,12 @@
11
# sphinx-rust
22

3+
[![PyPI][pypi-badge]][pypi-link]
4+
35
Sphinx plugin for documentation of Rust projects.
46

57
**UNDER DEVELOPMENT!**
68

79
See [docs/](docs/) for more information.
10+
11+
[pypi-badge]: https://img.shields.io/pypi/v/sphinx-rust.svg
12+
[pypi-link]: https://pypi.org/project/sphinx-rust

docs/index.rst

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
11
Sphinx Rust
22
===========
33

4-
Auto-document Rust code with :external:doc:`Sphinx <index>`!
4+
Auto-document `Rust <https://www.rust-lang.org/>`__ code with :external:doc:`Sphinx <index>`!
55

66
.. warning::
77

88
This project is in early development and is not yet ready for production use.
99

1010
It currently documents a subset of Rust code, and is not yet feature-complete, but this documents should give you a sense of what the final product will look like.
1111

12-
This package is intended to bring API documentation for rust crates to Sphinx:
12+
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

@@ -24,6 +24,9 @@ This package is intended to bring API documentation for rust crates to Sphinx:
2424
Installation
2525
------------
2626

27+
.. image:: https://img.shields.io/pypi/v/sphinx-rust
28+
:target: https://pypi.org/project/sphinx-rust/
29+
2730
.. code-block:: bash
2831
2932
pip install sphinx-rust

docs/integrations/needs.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,16 +22,24 @@ We can then create requirements and test cases from Rust code:
2222

2323
.. code-block:: restructuredtext
2424
25+
.. rubric:: Need-list example
26+
2527
.. needlist::
2628
:tags: rust
2729
30+
.. rubric:: Need-table example
31+
2832
.. needtable::
2933
:tags: rust
3034
:style: table
3135
36+
.. rubric:: Need-list example
37+
3238
.. needlist::
3339
:tags: rust
3440

41+
.. rubric:: Need-table example
42+
3543
.. needtable::
3644
:tags: rust
3745
:style: table

0 commit comments

Comments
 (0)