diff options
| author | OpenShift Merge Robot <openshift-merge-robot@users.noreply.github.com> | 2019-10-31 19:39:44 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2019-10-31 19:39:44 +0100 |
| commit | ffe36ea9964242235571ad1d21a0c4d825ef5971 (patch) | |
| tree | b38d2d9c492ab2b2ad951135fde7e90c37344711 /docs/Readme.md | |
| parent | 3e2d9f8662663f2f703bf674408d5255e493e18e (diff) | |
| parent | 486fcd4e1e6f00424f1016d8e331582523bd2c68 (diff) | |
| download | podman-ffe36ea9964242235571ad1d21a0c4d825ef5971.tar.gz podman-ffe36ea9964242235571ad1d21a0c4d825ef5971.tar.bz2 podman-ffe36ea9964242235571ad1d21a0c4d825ef5971.zip | |
Merge pull request #4354 from baude/newdocsstruct
Restructure documentation dir
Diffstat (limited to 'docs/Readme.md')
| -rw-r--r-- | docs/Readme.md | 21 |
1 files changed, 21 insertions, 0 deletions
diff --git a/docs/Readme.md b/docs/Readme.md new file mode 100644 index 000000000..4514afa77 --- /dev/null +++ b/docs/Readme.md @@ -0,0 +1,21 @@ +# Build the Docs + +## Directory Structure + +| | Directory | +| ------------------------------------ | --------------------------- | +| Markdown source for man pages | docs/source/markdown/ | +| man pages aliases as .so files | docs/source/markdown/links/ | +| restructured text for readthedocs.io | docs/rst/ | +| target for output | docs/build | +| man pages | docs/build/man | +| remote linux man pages | docs/build/remote/linux | +| remote darwin man pages | docs/build/remote/darwin | +| remote windows html pages | docs/build/remote/windows | + +## Support files + +| | | +| ------------------------------------ | --------------------------- | +| docs/remote-docs.sh | Read the docs/source/markdown files and format for each platform | +| docs/links-to-html.lua | pandoc filter to do aliases for html files |
\ No newline at end of file |