Skip to content

Commit

Permalink
README: add links for documents
Browse files Browse the repository at this point in the history
Signed-off-by: Hiroshi Miura <miurahr@linux.com>
  • Loading branch information
miurahr committed Jul 3, 2020
1 parent a6ef633 commit 3398e95
Showing 1 changed file with 27 additions and 4 deletions.
31 changes: 27 additions & 4 deletions README.rst
Expand Up @@ -103,12 +103,35 @@ Here is a table of algorithms.
.. _`lzma module document`: https://docs.python.org/3/library/lzma.html?highlight=lzma#specifying-custom-filter-chains


Document
========
Documents
=========

User manuals
------------

* `User Guide`_ for latest version.

* `API guide`_ for latest version.

* `Manual`_ for stable version.

Developer guide
---------------

* `Contributor guide`_ for one want to contribute the project.

* `7z file specification`_


.. _`manual` : https://py7zr.readthedocs.io/en/stable/
.. _`User Guide`: https://py7zr.readthedocs.io/en/latest/user_guide.html

.. _`API guide` : https://py7zr.readthedocs.io/en/latest/api.html
Here is a readthedocs `manual`_ document. It also describe design and classes.
.. _`Contributor guide` : https://py7zr.readthedocs.io/en/latest/contribution.html
.. _`manual`: https://py7zr.readthedocs.io/en/latest/
.. _`7z file specification` : https://py7zr.readthedocs.io/en/latest/archive_format.html
CLI Usage
Expand Down

0 comments on commit 3398e95

Please sign in to comment.