* 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>
* Cool columns of tutorials sorted by experience level.
Signed-off-by: Kevin Putnam <kevin.putnam@intel.com>
* Fixed wording of 1st paragraph
Signed-off-by: Kevin Putnam <kevin.putnam@intel.com>
* Moved kubernetes to High category.
Signed-off-by: Kevin Putnam <kevin.putnam@intel.com>
* Made change to address github action check.
Signed-off-by: Kevin Putnam <kevin.putnam@intel.com>
* Restored to :ref: from :doc:
Signed-off-by: Kevin Putnam <kevin.putnam@intel.com>
* Updates tutorial index with latest changes on master.
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>
* Adds support for multiple columns in reStructuredText. Required for landing page redesign.
Signed-off-by: Kevin Putnam <kevin.putnam@intel.com>
* Catching the branch up to master.
Signed-off-by: Kevin Putnam <kevin.putnam@intel.com>
* Fixing line endings in tcs_theme.js.
Signed-off-by: Kevin Putnam <kevin.putnam@intel.com>
* Added support for labeling code blocks. Currently supported code blocks:
* yaml
* bash
* console
* reStructuredText
* Python
* PowerShell
Handling added for re-aligning code blocks with line numbers with labels.
Signed-off-by: Kevin Putnam <kevin.putnam@intel.com>
* Adds the following code block handlers:
* Diff
* C
* json
* spec
* Perl
* PHP
* xml
Signed-off-by: Kevin Putnam <kevin.putnam@intel.com>
* Fixes behavior and appearance of permalinks in collapsible sections.
* Fixes links to collapsible sections so that header is now target.
Signed-off-by: Kevin Putnam <kevin.putnam@intel.com>
- Update to use regex to match hostname for cross domain tracking
- Update to set useAnchor to true
- Update to use https when adding analytics.js
Signed-off-by: Kristal Dale <kristal.dale@intel.com>
* Changed underline of search box to white from black.
* Added white border to differentiate clearlinux.org nav elements from docs. Limitations:
* Current solution fails to work 100% in responsive mode.
* Degradation is graceful.
* Better fix requires deeper change to the theme.
* Pending update pulling RTD theme into the project will allow this.
Signed-off-by: Kevin Putnam <kevin.putnam@intel.com>
Changes to be committed:
modified: source/_themes/otc_tcs_sphinx_theme/layout.html
modified: source/_themes/otc_tcs_sphinx_theme/static/tcs_theme.css
* Add code to show status and assign color-coding to available bundles.
- Add regex PATTERN4 to capture bundle status values
- Add code to process capture groups in for loop
- Rename bundler() to main() to follow Python convention
- Add conditional blocks to filter tags based on below status indicators
- Add css classes for active-status, wip-status, and pending-delete-status
- Closes#747
Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
* Programs "Deprecated" status for such bundles; color-codes it in css.
Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
* Adds #ce2029 color for "Deprecated" status to css; reorders css classes.
Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
* Revises HTML relative link in template.html to tcs_theme.css.
Signed-off-by: Michael Vincerra <michael.vincerra@intel.com>
* Adding magnifying glass to search field.
Signed-off-by: Kevin Putnam <kevin.putnam@intel.com>
* Moved magnifying glass to the left and shifted text to right in search field.
Signed-off-by: Kevin Putnam <kevin.putnam@intel.com>
* Embedded image in css to avoid sticky path issues.
Signed-off-by: Kevin Putnam <kevin.putnam@intel.com>
* Reverting to relative path to .css
Signed-off-by: Kevin Putnam <kevin.putnam@intel.com>
* Removed link at left of header that went to clearlinux.org
* Added "home" button on right side of header that goes to clearlinux.org
Signed-off-by: Kevin Putnam <kevin.putnam@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