summaryrefslogtreecommitdiff
path: root/docs/source/conf.py
Commit message (Collapse)AuthorAge
* Fix long option format on docs.podman.ioPaul Holzinger2021-03-29
| | | | | | | | | | | | | | | | | | | 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>
* Make podman service log eventsJhon Honce2020-11-19
| | | | | | | | | * Log endpoint calls at level Info * Ensure API server started at level Info Fixes #8390 Signed-off-by: Jhon Honce <jhonce@redhat.com>
* Fix markdown tables on docs.podman.ioPaul Holzinger2020-11-13
| | | | | | | | | | | Sphinx with recommonmark cannot render markdown tables at all. There is a python package called `sphinx-markdown-tables` which adds the markdown table support to recommonmark. https://pypi.org/project/sphinx-markdown-tables/ By utilising this package we don't have to change our doc format. Signed-off-by: Paul Holzinger <paul.holzinger@web.de>
* Refactor to use DockerClient vs APIClientJhon Honce2020-11-12
| | | | | | | * Update tests and framework * remove tests for APIClient methods Signed-off-by: Jhon Honce <jhonce@redhat.com>
* Add anchors for flag names on docs.podman.ioPaul Holzinger2020-11-10
| | | | | | | | | | Change the docs markdown so that flag names will be h4 headers. Sphinx will automatically add anchors to headers. Add css to make sure the flag names are not to big compared to the text. The man pages also still renders fine but it looks a bit different. Signed-off-by: Paul Holzinger <paul.holzinger@web.de>
* Restructure documentation dirbaude2019-10-31
Restructuring the docs dir to make integration with sphinx easier. man pages now exist in docs/source/man and the sphinx make files exists in docs. Signed-off-by: baude <bbaude@redhat.com>