diff options
| author | Paul Holzinger <pholzing@redhat.com> | 2021-09-16 18:57:36 +0200 |
|---|---|---|
| committer | Paul Holzinger <pholzing@redhat.com> | 2021-09-16 21:10:13 +0200 |
| commit | 7ca666f47492f60185efcbcacfddb2c8e7dc661a (patch) | |
| tree | 5b358b231f0cd6de6edbfc9e6f7c385996694fee /docs/requirements.txt | |
| parent | 9119a578e782b92bd344f093f5491c318bc20d69 (diff) | |
| download | podman-7ca666f47492f60185efcbcacfddb2c8e7dc661a.tar.gz podman-7ca666f47492f60185efcbcacfddb2c8e7dc661a.tar.bz2 podman-7ca666f47492f60185efcbcacfddb2c8e7dc661a.zip | |
Use a new markdown converter for sphinx
Recommonmark has many issues and is deprecated. The recommended
alternative is MyST-Parser. [1]
The myst parser looks great, it also correctly parses tables and adds the
correct links.
To test locallay run:
```
cd docs
rm -rf build/
\# install build deps
sudo dnf install python3-sphinx && pip install myst-parser
make html
python -m http.server 8000 --directory build/html
\# Now check in your browser if it looks good to you
```
[1] https://github.com/readthedocs/recommonmark/issues/221
Signed-off-by: Paul Holzinger <pholzing@redhat.com>
Diffstat (limited to 'docs/requirements.txt')
| -rw-r--r-- | docs/requirements.txt | 4 |
1 files changed, 1 insertions, 3 deletions
diff --git a/docs/requirements.txt b/docs/requirements.txt index 84e7ec6a5..3ba6d658f 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1,6 +1,4 @@ # requirements file for readthedocs pip installs # use md instead of rst -recommonmark -# needed for markdown table support -sphinx-markdown-tables +myst_parser |