The documentation pack comprises the elements below
- doc.rst - the source file with DVC product documentation in the format of RST text markup
- doc.html - the final HTML form of the documentation (ready to redistribute or publish on the site)
- cmd.bat - the command file that uses pandoc to convert doc.rst -> doc.html
- header.html - the HTML file with the code fragment to insert into HEADER tag of doc.html
- footer.html - the HTML file with the code fragment to insert into doc.html after the output produced by pandoc and before </body> tag
- top.html - the HTML file with the code fragment to insert into doc.html just after <body> tag, before the output generated by pandoc
- files in auxiliary folders (js, css, imaged) are used to create the appropriate look and feel of doc.html (they shall be redistributed along with doc.html)
-- Note: css/style.css is the place to edit major styles for DVC product documentation
-
George Vyshnya