diff options
| author | Charles Cabergs <me@cacharle.xyz> | 2021-02-28 18:46:38 +0100 |
|---|---|---|
| committer | Charles Cabergs <me@cacharle.xyz> | 2021-02-28 18:51:01 +0100 |
| commit | 50c413b6f3c02c63b143ad4abf2e357cf7b2fbb0 (patch) | |
| tree | d0b3a3dcfad6b3d29e52054df0eb8c8a1ca97dba /docs | |
| parent | 8b613be06c58b33892e9b6501621899fde8fa8df (diff) | |
| download | minishell_test-50c413b6f3c02c63b143ad4abf2e357cf7b2fbb0.tar.gz minishell_test-50c413b6f3c02c63b143ad4abf2e357cf7b2fbb0.tar.bz2 minishell_test-50c413b6f3c02c63b143ad4abf2e357cf7b2fbb0.zip | |
Updated README.rst to generate inline image shields
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/README.rst | 25 | ||||
| -rwxr-xr-x | docs/build-readme-md | 4 |
2 files changed, 19 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>`_. diff --git a/docs/build-readme-md b/docs/build-readme-md new file mode 100755 index 0000000..256bf63 --- /dev/null +++ b/docs/build-readme-md @@ -0,0 +1,4 @@ +#!/bin/sh + +# gfm = github flavored markdown +pandoc README.rst -f rst -t gfm > ../README.md |