diff options
| author | Paul Holzinger <paul.holzinger@web.de> | 2021-03-29 13:52:59 +0200 |
|---|---|---|
| committer | Matthew Heon <mheon@redhat.com> | 2021-03-29 13:53:50 -0400 |
| commit | ac4bdd265308f549c4db775c1674077a6c669b30 (patch) | |
| tree | a95f579c2d855ea2e4797fe04ee55aa20ec03372 /docs/source/conf.py | |
| parent | 96ffce2198785c9d5717e3104f0afd8a0c38b6af (diff) | |
| download | podman-ac4bdd265308f549c4db775c1674077a6c669b30.tar.gz podman-ac4bdd265308f549c4db775c1674077a6c669b30.tar.bz2 podman-ac4bdd265308f549c4db775c1674077a6c669b30.zip | |
Fix long option format on docs.podman.io
Escape the two dashes, otherwise they are combined into one long dash.
I tested that this change is safe and still renders correctly on github
and with the man pages.
This commit also contains a small change to make it build locally.
Assuming you have the dependencies installed you can do:
```
cd docs
make html
```
Preview the html files in docs/build/html with
`python -m http.server 8000 --directory build/html`.
Fixes containers/podman.io#373
Signed-off-by: Paul Holzinger <paul.holzinger@web.de>
<MH: Fixed cherry-pick conflicts>
Signed-off-by: Matthew Heon <mheon@redhat.com>
Diffstat (limited to 'docs/source/conf.py')
| -rw-r--r-- | docs/source/conf.py | 6 |
1 files changed, 1 insertions, 5 deletions
diff --git a/docs/source/conf.py b/docs/source/conf.py index e3715937d..883e1240e 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -29,13 +29,9 @@ author = "team" # ones. extensions = [ "sphinx_markdown_tables", + "recommonmark" ] -source_parsers = { - ".md": "recommonmark.parser.CommonMarkParser", -} - - # Add any paths that contain templates here, relative to this directory. templates_path = ["_templates"] |