diff options
| author | Jhon Honce <jhonce@redhat.com> | 2019-10-29 17:27:12 -0700 |
|---|---|---|
| committer | Matthew Heon <mheon@redhat.com> | 2019-10-31 16:34:29 -0400 |
| commit | 28ad43940f3bfca3870a5450342c4b79c6a2f60f (patch) | |
| tree | e09c845896ba74942de8ec13e4404df393f374a5 /docs/Readme.md | |
| parent | 27e79f55407b9e46cee06c97ba53bc3a485f5c03 (diff) | |
| download | podman-28ad43940f3bfca3870a5450342c4b79c6a2f60f.tar.gz podman-28ad43940f3bfca3870a5450342c4b79c6a2f60f.tar.bz2 podman-28ad43940f3bfca3870a5450342c4b79c6a2f60f.zip | |
Update document formatting and packaging code
* Refactored code and Makefile to support new docs layout
* Removed some old code packaging code
* Add Readme.md to document what we're doing
Signed-off-by: Jhon Honce <jhonce@redhat.com>
Signed-off-by: baude <bbaude@redhat.com>
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 |