aboutsummaryrefslogtreecommitdiff
path: root/docs/README.rst
diff options
context:
space:
mode:
Diffstat (limited to 'docs/README.rst')
-rw-r--r--docs/README.rst25
1 files changed, 15 insertions, 10 deletions
diff --git a/docs/README.rst b/docs/README.rst
index fc5c802..f8a56e8 100644
--- a/docs/README.rst
+++ b/docs/README.rst
@@ -1,17 +1,17 @@
minishell_test
==============
-.. image:: https://img.shields.io/pypi/pyversions/minishell-test
- :alt: PyPI - Python Version
- :target: https://pypi.org/project/minishell-test/
+.. |pypi-python-version| image:: https://img.shields.io/pypi/pyversions/minishell-test
+ :alt: PyPI - Python Version
+ :target: https://pypi.org/project/minishell-test/
+.. |documentation-build| image:: https://readthedocs.org/projects/minishell-test/badge/?version=latest
+ :alt: Documentation
+ :target: https://minishell-test.readthedocs.io
+.. |travis-build| image:: https://api.travis-ci.com/cacharle/minishell_test.svg?branch=master
+ :alt: Build Status
+ :target: https://travis-ci.com/cacharle/minishell_test
-.. image:: https://readthedocs.org/projects/minishell-test/badge/?version=latest
- :alt: Documentation
- :target: https://minishell-test.readthedocs.io
-
-.. image:: https://api.travis-ci.com/cacharle/minishell_test.svg?branch=master
- :alt: Build Status
- :target: https://travis-ci.com/cacharle/minishell_test
+|pypi-python-version| |documentation-build| |travis-build|
Test for 42 school's minishell project.
@@ -19,3 +19,8 @@ Test for 42 school's minishell project.
:alt: preview
.. include:: gettingstarted.rst
+
+Documentation
+-------------
+
+The full documentation for this project is available at `minishell-test.readthedocs.io<https://minishell-test.readthedocs.io>`_.