* Adds support for sphinx_copybutton.
Closes#1134
Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
* Additional config.
Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
* Remove cruft.;)
Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
* **DO NOT MERGE** Please verify changes with tutorials/proxy.rst. Once verified remove changes to proxy.rst.
Signed-off-by: Kevin Putnam <kevin.putnam@intel.com>
* Provides example usage of new codeblock copy behavior:
1. ShellSession (line 228 in kernel-modules-dkms.rst) - will copy everything except prompt.
2. Console (line 74 in kernel-modules-dkms.rst) - will copy only the input line without the prompt.
Signed-off-by: Kevin Putnam <kevin.putnam@intel.com>
Co-authored-by: Michael Vincerra <michael.vincerra@intel.com>
* Build manpages with "make man".
Signed-off-by: Kevin Putnam <kevin.putnam@intel.com>
* Adds "make man" to github workflows.
Signed-off-by: Kevin Putnam <kevin.putnam@intel.com>
* Remove shell script dependency.
Signed-off-by: Kevin Putnam <kevin.putnam@intel.com>
* Change git URLs to https.
Signed-off-by: Kevin Putnam <kevin.putnam@intel.com>
* Moved git clone to Makefile.
Signed-off-by: Kevin Putnam <kevin.putnam@intel.com>
* Fixed typo.
Signed-off-by: Kevin Putnam <kevin.putnam@intel.com>
* Adding pandoc install.
Signed-off-by: Kevin Putnam <kevin.putnam@intel.com>
* Moved to Makefile.
Signed-off-by: Kevin Putnam <kevin.putnam@intel.com>
* First commit toward programmatic creation of manpages.rst
Signed-off-by: Kevin Putnam <kevin.putnam@intel.com>
* Multiple updates:
1. man-pages.rst now generated by script.
2. Updated Makefile and make.bat with "man" and "clean-man" recipes.
3. Fixed typo in conf.py.
4. Many improvements to manpages.py
Signed-off-by: Kevin Putnam <kevin.putnam@intel.com>
* Updated readme for man pages and added man-pages.rst
Signed-off-by: Kevin Putnam <kevin.putnam@intel.com>
- Contributors may run `make venv` and install requirements.txt without modifying host OS
- Innermost `requirements.txt`, 2 dependencies, moved to uppermost requirements.txt
- Adds `venv` to .gitignore in case contributors/developer forget to remove.
- Reverts source/conf.py to original.
- Replaces python command with python3 in innermost _python/Makefile
Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
* Both Chinese and English are built for error checking purposes only (parallel dirs /source/_build/html and /source/_build/zh_CN).
* Next stage will be to move building of simplified Chinese to https://github.com/clearlinux/clear-linux-documentation-zh-CN only and use latest release from that repo.
Signed-off-by: Kevin Putnam <kevin.putnam@intel.com>
- Adds new 'py' directive with Bash script
- Adds same Bash script under json directive
- Invoke child Makefile in /scripts/_python
- Execute bundle_lister.py
- Provide 'py' directive for future Python scripts
Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
Changed the file structure to allow for easier and better maintenance of
the docs. Files were renamed as needed and following a consistent
convention. Added a index.rst to every folder allowing for partial
builds of the docs. Included content previously left out of the docs
build. The commit also performs minimal housekeeping.
Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
Kevin Putnam