Skip to content
This repository contains the documentation source files for Clear Linux OS.
JavaScript Python HTML CSS Makefile Batchfile Shell
Branch: master
Clone or download
intelkevinputnam and mvincerx Added a magnifying glass icon to the search field and changed placeho…
…lder text. (#734)

* 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>
Latest commit 084d7b3 Aug 23, 2019

README.rst

Documentation build instructions

Clear Linux* OS documentation is written using reStructuredText and built using Sphinx. Follow the instructions in this README to build the documentation locally for development and testing.

Please make yourself familiar with our contribution guidelines before submitting a contribution.

Requirements

Make sure you have Python and Sphinx installed. We use Python 3 and Sphinx 1.7.5

The Sphinx documentation provides instructions for installing Sphinx on various platforms.

Clone the documentation repository

Once Sphinx is installed, clone the documentation repository to your local machine.

$ git clone https://github.com/clearlinux/clear-linux-documentation

Run the build

We build our documentation using Sphinx. In the source directory of your local clear-linux-documentation repository, build the documentation by running make html:

$ make html
>
sphinx-build -b html -d _build/doctrees   . _build/html
Running Sphinx v1.7.5
making output directory...
.
.
.
build succeeded, 0 warnings.

The HTML pages are in _build/html.

Build finished. The HTML pages are in _build/html.

Open one of the HTML pages in a web browser to view the rendered documentation.

When testing changes in the documentation, make sure to remove the previous build before building again by running make clean:

$ make clean
>
rm -rf _build/*

This will completely remove the previous build output.

You can’t perform that action at this time.