* 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>
* Adding support for reDocs GUI to Clear Linux Docs repo.
1. Added .tox and MANIFEST to .gitignore
2. Added py rule to make.bat to enable building of bundles.html.txt in Windows
3. Added .tox to exclude_patterns in conf.py
4. Added tox.ini and setup.py support files to project.
Signed-off-by: Kevin Putnam <kevin.putnam@intel.com>
* Updated setup.py with Clear Linux docs info.
Signed-off-by: Kevin Putnam <kevin.putnam@intel.com>
* Small adjustment.
Signed-off-by: Kevin Putnam <kevin.putnam@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>
* 1. Updated landing page to emulate look and feel of docs page on clearlinux.org
2. Added Trademarks, Cookies, and Privacy Terms links to footer with some css formatting
3. Added some CSS to pre-emptively remove added formatting to definition list entries in sphinx/rtd theme in version 2 and above
Signed-off-by: Kevin Putnam <kevin.putnam@intel.com>
* Added start/end for footer bullet list support
Signed-off-by: Kevin Putnam <kevin.putnam@intel.com>
* 1. Hid toctree to reduce duplication.
2. Changed IRC link to match what is currently on the clearlinux.org site.
Signed-off-by: Kevin Putnam <kevin.putnam@intel.com>
- Added static html pages for 404 and 403 server responses.
- Added conf.py setting html_extra_path to copy static _errors folder
with static 404/403 files into build output
Signed-off-by: Kristal Dale <kristal.dale@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>
-Edits to about page (per request)
-Edits to landing page (per request)
-Moved bootable usb out of containing folder (unnecessary)
-Update conf future version name
Signed-off-by: Kristal Dale <kristal.dale@intel.com>
- new localization directory includes all .pot and .po files used in transaltions
- updated config to include sphinx-intl settings
Signed-off-by: Kristal Dale <kristal.dale@intel.com>
- Substitutions
- Python config file
- Replace hard coded product name in page heading with sub on CL doc landing page
- Replace hard coded product name with sub in system-requirements
Signed-off-by: Kristal Dale <kristal.dale@intel.com>
A warning is showed when compiling the documentation:
WARNING: html_static_path entry '/home/git/clear-linux-documentation/source/_static' does not exist
After documentation restructure, the _static directory is no more needed.
This commit comment out html_static_path in config.py, and the warning
is not showed.
When compiling documentation a warning message is showed:
WARNING: The config value `html_add_permalinks' has type `bool', defaults to `str'.
The documentation from http://www.sphinx-doc.org/es/stable/config.html
said to set it to None or the empty string to disable permalinks.
Now it is set to empty string and the warning disappear.
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