Compare commits
1 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| 319727628b |
@@ -0,0 +1,4 @@
|
|||||||
|
# Sphinx build info version 1
|
||||||
|
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
|
||||||
|
config: cc99ba4fd98ddc62c1fab24f336360f5
|
||||||
|
tags: 645f666f9bcd5a90fca523b33c5a78b7
|
||||||
@@ -1,20 +0,0 @@
|
|||||||
---
|
|
||||||
name: Identify 'Guides' Type by Role -- For Guides only.
|
|
||||||
about: For new content in 'Guides', select 1 of 3 categories to which it belongs.
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
New pages will appear here: https://clearlinux.org/documentation/clear-linux/guides
|
|
||||||
|
|
||||||
1. Enter an 'x' in the category for the new "guide":
|
|
||||||
* [ ] Basics
|
|
||||||
* [ ] Developer
|
|
||||||
* [ ] Administrator
|
|
||||||
|
|
||||||
Complete the field below, following the colon, that matches option selected above:
|
|
||||||
|
|
||||||
I am a Clear Linux Beginner (Basics). I want to learn how to:
|
|
||||||
|
|
||||||
I am a Clear Linux Developer. I want to learn how to:
|
|
||||||
|
|
||||||
I am a Clear Linux Administrator. I want to learn how to:
|
|
||||||
@@ -1,6 +0,0 @@
|
|||||||
#Exluding from the tree the html build files
|
|
||||||
source/_build
|
|
||||||
# ignore vi temporary files
|
|
||||||
*.swp
|
|
||||||
*~
|
|
||||||
.*~
|
|
||||||
@@ -1,16 +0,0 @@
|
|||||||
# Makefile for Sphinx documentation
|
|
||||||
#
|
|
||||||
|
|
||||||
all:
|
|
||||||
make -C source html
|
|
||||||
|
|
||||||
html:
|
|
||||||
make -C source html
|
|
||||||
|
|
||||||
help:
|
|
||||||
@echo "Please use \`make <target>' where <target> is one of"
|
|
||||||
@echo " html to make standalone HTML files"
|
|
||||||
|
|
||||||
clean:
|
|
||||||
make -C source clean
|
|
||||||
|
|
||||||
@@ -1,83 +0,0 @@
|
|||||||
Documentation Build Instructions
|
|
||||||
################################
|
|
||||||
|
|
||||||
The `website documentation`_ for Clear Linux\* OS for Intel Architecture
|
|
||||||
should be written in :abbr:`ReStructuredText (ReST)` AKA ``.rst``, which
|
|
||||||
makes it easy to build parsable, command-line readable, indexed, and
|
|
||||||
search-friendly documentation and APIs with `Sphinx`_.
|
|
||||||
|
|
||||||
.. _requirements:
|
|
||||||
|
|
||||||
Requirements
|
|
||||||
============
|
|
||||||
|
|
||||||
To build documentation with Sphinx, ensure your system has these
|
|
||||||
prerequisites:
|
|
||||||
|
|
||||||
* `GNU make`_
|
|
||||||
* `Python`_
|
|
||||||
* `PIP`_
|
|
||||||
* `Sphinx`_
|
|
||||||
|
|
||||||
The instructions for installing these varies according to OS. On a basic out-
|
|
||||||
of-the-box Ubuntu-like OS (which usually has Python installed by default),
|
|
||||||
check your python version you might need something like:
|
|
||||||
|
|
||||||
.. code-block:: console
|
|
||||||
|
|
||||||
$ sudo apt-get install python-pip
|
|
||||||
$ sudo pip install -U sphinx sphinx-autobuild
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
.. code-block:: console
|
|
||||||
|
|
||||||
$ python -c 'print __import__("sphinx").__version__'
|
|
||||||
1.3.1
|
|
||||||
|
|
||||||
Cloning the documentation repository
|
|
||||||
====================================
|
|
||||||
|
|
||||||
We have confirmed Sphinx installed. The next step is to clone Gitlab
|
|
||||||
repository to our local machine.
|
|
||||||
|
|
||||||
|
|
||||||
.. code-block:: console
|
|
||||||
|
|
||||||
$ git clone https://github.com/clearlinux/clear-linux-documentation
|
|
||||||
|
|
||||||
Run make
|
|
||||||
========
|
|
||||||
|
|
||||||
Finally are we ready to run :command:`make`. Be sure to :command:`cd` to the
|
|
||||||
:file:`source/` directory where your ``.rst`` files are, before
|
|
||||||
running :command:`make html`, or the doc format of your choice.
|
|
||||||
|
|
||||||
.. code-block:: console
|
|
||||||
|
|
||||||
$ make html
|
|
||||||
>
|
|
||||||
sphinx-build -b html -d _build/doctrees . _build/html
|
|
||||||
Running Sphinx v1.3.1
|
|
||||||
making output directory...
|
|
||||||
.
|
|
||||||
.
|
|
||||||
.
|
|
||||||
build succeeded, 0 warnings.
|
|
||||||
|
|
||||||
Build finished. The HTML pages are in _build/html.
|
|
||||||
|
|
||||||
Open one of the .html pages in a web browser to view the rendered
|
|
||||||
documentation.
|
|
||||||
|
|
||||||
For tips on how to contribute documentation formatted in the .rst style
|
|
||||||
needed to integrate beautifully on the clearlinux.org website, please see
|
|
||||||
`Theming Sphinx`_.
|
|
||||||
|
|
||||||
|
|
||||||
.. _website documentation: https://clearlinux.org/documentation
|
|
||||||
.. _Sphinx: http://sphinx-doc.org/
|
|
||||||
.. _GNU make: https://www.gnu.org/software/make/
|
|
||||||
.. _Python: https://www.python.org/
|
|
||||||
.. _PIP: https://pypi.python.org/pypi/pip/
|
|
||||||
.. _Theming Sphinx: https://github.com/otcshare/tcs-hub/blob/master/theming-sphinx.rst
|
|
||||||
|
After Width: | Height: | Size: 19 KiB |
|
After Width: | Height: | Size: 137 KiB |
|
Before Width: | Height: | Size: 1.3 MiB After Width: | Height: | Size: 1.3 MiB |
|
Before Width: | Height: | Size: 823 KiB After Width: | Height: | Size: 823 KiB |
|
After Width: | Height: | Size: 39 KiB |
|
After Width: | Height: | Size: 67 KiB |
|
After Width: | Height: | Size: 52 KiB |
|
After Width: | Height: | Size: 51 KiB |
|
After Width: | Height: | Size: 45 KiB |
|
After Width: | Height: | Size: 137 KiB |
|
After Width: | Height: | Size: 103 KiB |
|
After Width: | Height: | Size: 70 KiB |
|
After Width: | Height: | Size: 93 KiB |
|
After Width: | Height: | Size: 69 KiB |
|
After Width: | Height: | Size: 49 KiB |
|
After Width: | Height: | Size: 138 KiB |
|
After Width: | Height: | Size: 57 KiB |
|
After Width: | Height: | Size: 51 KiB |
|
After Width: | Height: | Size: 74 KiB |
|
After Width: | Height: | Size: 92 KiB |
|
After Width: | Height: | Size: 48 KiB |
|
After Width: | Height: | Size: 62 KiB |
|
After Width: | Height: | Size: 14 KiB |
|
After Width: | Height: | Size: 24 KiB |
|
Before Width: | Height: | Size: 255 KiB After Width: | Height: | Size: 255 KiB |
|
Before Width: | Height: | Size: 213 KiB After Width: | Height: | Size: 213 KiB |
|
Before Width: | Height: | Size: 307 KiB After Width: | Height: | Size: 307 KiB |
|
Before Width: | Height: | Size: 60 KiB After Width: | Height: | Size: 60 KiB |
|
Before Width: | Height: | Size: 221 KiB After Width: | Height: | Size: 221 KiB |
|
Before Width: | Height: | Size: 275 KiB After Width: | Height: | Size: 275 KiB |
|
Before Width: | Height: | Size: 295 KiB After Width: | Height: | Size: 295 KiB |
|
Before Width: | Height: | Size: 161 KiB After Width: | Height: | Size: 161 KiB |
|
Before Width: | Height: | Size: 208 KiB After Width: | Height: | Size: 208 KiB |
|
Before Width: | Height: | Size: 272 KiB After Width: | Height: | Size: 272 KiB |
|
Before Width: | Height: | Size: 207 KiB After Width: | Height: | Size: 207 KiB |
|
Before Width: | Height: | Size: 277 KiB After Width: | Height: | Size: 277 KiB |
|
Before Width: | Height: | Size: 77 KiB After Width: | Height: | Size: 77 KiB |
|
Before Width: | Height: | Size: 213 KiB After Width: | Height: | Size: 213 KiB |
|
Before Width: | Height: | Size: 116 KiB After Width: | Height: | Size: 116 KiB |
|
Before Width: | Height: | Size: 133 KiB After Width: | Height: | Size: 133 KiB |
|
Before Width: | Height: | Size: 128 KiB After Width: | Height: | Size: 128 KiB |
|
After Width: | Height: | Size: 14 KiB |
|
After Width: | Height: | Size: 14 KiB |
|
After Width: | Height: | Size: 189 KiB |
|
After Width: | Height: | Size: 60 KiB |
|
After Width: | Height: | Size: 84 KiB |
|
After Width: | Height: | Size: 75 KiB |
|
After Width: | Height: | Size: 15 KiB |
|
After Width: | Height: | Size: 34 KiB |
|
After Width: | Height: | Size: 36 KiB |
|
After Width: | Height: | Size: 45 KiB |
|
After Width: | Height: | Size: 46 KiB |
|
After Width: | Height: | Size: 44 KiB |
|
After Width: | Height: | Size: 53 KiB |
|
After Width: | Height: | Size: 94 KiB |
|
After Width: | Height: | Size: 105 KiB |
|
After Width: | Height: | Size: 16 KiB |
|
After Width: | Height: | Size: 39 KiB |
|
After Width: | Height: | Size: 74 KiB |
|
After Width: | Height: | Size: 74 KiB |
|
After Width: | Height: | Size: 77 KiB |
|
After Width: | Height: | Size: 14 KiB |
|
After Width: | Height: | Size: 49 KiB |
|
After Width: | Height: | Size: 92 KiB |
|
After Width: | Height: | Size: 31 KiB |
|
After Width: | Height: | Size: 77 KiB |
|
After Width: | Height: | Size: 40 KiB |
|
After Width: | Height: | Size: 45 KiB |
|
After Width: | Height: | Size: 64 KiB |
|
After Width: | Height: | Size: 31 KiB |
|
After Width: | Height: | Size: 78 KiB |
|
After Width: | Height: | Size: 80 KiB |
|
After Width: | Height: | Size: 81 KiB |
|
After Width: | Height: | Size: 46 KiB |
|
After Width: | Height: | Size: 46 KiB |
|
After Width: | Height: | Size: 37 KiB |
|
After Width: | Height: | Size: 88 KiB |
|
After Width: | Height: | Size: 43 KiB |
|
After Width: | Height: | Size: 35 KiB |
|
After Width: | Height: | Size: 26 KiB |
|
After Width: | Height: | Size: 93 KiB |
|
After Width: | Height: | Size: 195 KiB |
|
After Width: | Height: | Size: 56 KiB |
|
After Width: | Height: | Size: 42 KiB |
|
After Width: | Height: | Size: 54 KiB |
|
After Width: | Height: | Size: 54 KiB |
|
After Width: | Height: | Size: 69 KiB |
|
After Width: | Height: | Size: 85 KiB |
|
After Width: | Height: | Size: 41 KiB |
|
After Width: | Height: | Size: 30 KiB |
|
After Width: | Height: | Size: 94 KiB |
|
After Width: | Height: | Size: 80 KiB |
|
After Width: | Height: | Size: 40 KiB |
|
Before Width: | Height: | Size: 116 KiB After Width: | Height: | Size: 116 KiB |