Compare commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
67d8d35f82 | ||
|
|
2c24dd4d4a | ||
|
|
1dc3d59bc4 | ||
|
|
d0e71c8f5a | ||
|
|
2327247a29 | ||
|
|
c0981002a6 | ||
|
|
6627f3105a | ||
|
|
52ea187067 | ||
|
|
10165b31ba | ||
|
|
f481cbeaca | ||
|
|
ff5f2e41c7 | ||
|
|
637ebdc2ba | ||
|
|
1b8fe35939 | ||
|
|
ce3a6c3321 | ||
|
|
10d167b543 | ||
|
|
2020f5b1a6 | ||
|
|
c913639121 | ||
|
|
fb989f6291 | ||
|
|
8e32449d47 | ||
|
|
97cc3cfbbd | ||
|
|
df0063ef02 | ||
|
|
41ca0a41b9 | ||
|
|
056119551c | ||
|
|
5071a60b34 | ||
|
|
4e16119846 | ||
|
|
81ea8a4e54 | ||
|
|
f975d1dc00 | ||
|
|
e90885986f | ||
|
|
7b21fb9159 | ||
|
|
b753e49df3 | ||
|
|
edbb9286e5 | ||
|
|
1b15019f03 | ||
|
|
f9d976de41 | ||
|
|
cdaa36e279 | ||
|
|
e2e1a2896c | ||
|
|
0a8674c530 | ||
|
|
7a4e6c6d1c | ||
|
|
410768be7e | ||
|
|
389887026e | ||
|
|
0aa9fad0ec | ||
|
|
96b4c58aa7 | ||
|
|
d539c6feff | ||
|
|
6e3e1d9135 | ||
|
|
f8207916a3 | ||
|
|
c98dfdad9c | ||
|
|
912bb57255 | ||
|
|
8ca656b901 | ||
|
|
112ec79c56 | ||
|
|
9264ae8b73 | ||
|
|
dbf84a7bb9 | ||
|
|
a39c15e550 | ||
|
|
74fd2fab55 | ||
|
|
c9134c7283 |
@@ -0,0 +1,13 @@
|
|||||||
|
name: Greetings
|
||||||
|
|
||||||
|
on: [pull_request, issues]
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
greeting:
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
steps:
|
||||||
|
- uses: actions/first-interaction@v1
|
||||||
|
with:
|
||||||
|
repo-token: ${{ secrets.GITHUB_TOKEN }}
|
||||||
|
issue-message: 'Welcome to Clear Linux* OS Docs. Thanks for submitting your first issue.'
|
||||||
|
pr-message: 'Welcome to Clear Linux* OS Docs. Thanks for submitting your first PR.'
|
||||||
@@ -34,7 +34,6 @@ clean:
|
|||||||
rm -rf venv
|
rm -rf venv
|
||||||
|
|
||||||
venv:
|
venv:
|
||||||
virtualenv -p python$(PY_VERSION) venv;
|
virtualenv venv;\
|
||||||
source venv/bin/activate; \
|
source venv/bin/activate; \
|
||||||
pip3 install -r requirements.txt;
|
pip3 install -r requirements.txt;
|
||||||
|
|
||||||
|
|||||||
@@ -67,6 +67,86 @@ If you want to build the documentation exactly as seen on the website, use
|
|||||||
``make py`` followed by ``make htmlall``. This builds some
|
``make py`` followed by ``make htmlall``. This builds some
|
||||||
external dependencies and all supported languages.
|
external dependencies and all supported languages.
|
||||||
|
|
||||||
|
Use virtualenv
|
||||||
|
**************
|
||||||
|
|
||||||
|
To develop documentation in a ``virtualenv``, use the ``venv`` target.
|
||||||
|
The Clear Linux OS documentation make target ``venv`` provides a
|
||||||
|
simple development environment that ensures that you have the
|
||||||
|
latest packages and that you manage Python versions separately. Use of the
|
||||||
|
``virtualenv`` requires **Python 3.6** or higher. For Windows examples below, use Powershell as an Administrator.
|
||||||
|
|
||||||
|
The **virtual environment** uses the same version of Python that was used to **create the virtual environment**.
|
||||||
|
|
||||||
|
Verify ``pip`` is installed. A file path to pip should appear.
|
||||||
|
|
||||||
|
On Clear Linux OS and macOS\*:
|
||||||
|
|
||||||
|
.. code-block:: bash
|
||||||
|
|
||||||
|
which pip
|
||||||
|
|
||||||
|
On Windows\* 10 OS:
|
||||||
|
|
||||||
|
.. code-block:: bash
|
||||||
|
|
||||||
|
pip --version
|
||||||
|
|
||||||
|
If ``pip`` is not installed, install it.
|
||||||
|
|
||||||
|
On Clear Linux OS and macOS:
|
||||||
|
|
||||||
|
.. code-block:: bash
|
||||||
|
|
||||||
|
python3 -m pip install --user --upgrade pip
|
||||||
|
|
||||||
|
On Windows 10 OS:
|
||||||
|
|
||||||
|
.. code-block:: bash
|
||||||
|
|
||||||
|
py -m pip install --upgrade pip
|
||||||
|
|
||||||
|
.. note::
|
||||||
|
|
||||||
|
This assumes Python was already added to your Windows path.
|
||||||
|
|
||||||
|
Install virtualenv
|
||||||
|
==================
|
||||||
|
|
||||||
|
Install ``virtualenv``.
|
||||||
|
|
||||||
|
On Clear Linux OS and macOS\*:
|
||||||
|
|
||||||
|
.. code-block:: bash
|
||||||
|
|
||||||
|
python3 -m pip install --user virtualenv
|
||||||
|
|
||||||
|
On Windows 10 OS:
|
||||||
|
|
||||||
|
.. code-block:: bash
|
||||||
|
|
||||||
|
py -m pip install --user virtualenv
|
||||||
|
|
||||||
|
Create the ``virtualenv`` and install the required packages:
|
||||||
|
|
||||||
|
.. code-block:: bash
|
||||||
|
|
||||||
|
make venv
|
||||||
|
|
||||||
|
Activate the ``venv``.
|
||||||
|
|
||||||
|
.. code-block:: bash
|
||||||
|
|
||||||
|
source venv/bin/activate
|
||||||
|
|
||||||
|
Follow `Run the build`_ section to start developing documentation.
|
||||||
|
|
||||||
|
Remove the ``venv`` when finished developing.
|
||||||
|
|
||||||
|
.. code-block:: bash
|
||||||
|
|
||||||
|
deactivate
|
||||||
|
|
||||||
Additional help
|
Additional help
|
||||||
***************
|
***************
|
||||||
|
|
||||||
@@ -80,7 +160,8 @@ build before building again by running ``make clean``:
|
|||||||
|
|
||||||
make clean
|
make clean
|
||||||
|
|
||||||
This will completely remove the previous build output.
|
This will completely remove the previous build output, including artifacts
|
||||||
|
from the `make venv` target when done outside an active venv.
|
||||||
|
|
||||||
Convenience script
|
Convenience script
|
||||||
==================
|
==================
|
||||||
|
|||||||
@@ -6,3 +6,4 @@ sphinx-intl==2.0.0
|
|||||||
sphinx-sitemap==1.0.2
|
sphinx-sitemap==1.0.2
|
||||||
Jinja2==2.10.1
|
Jinja2==2.10.1
|
||||||
GitPython==2.1.11
|
GitPython==2.1.11
|
||||||
|
sphinx-tabs
|
||||||
|
|||||||
|
After Width: | Height: | Size: 212 KiB |
|
After Width: | Height: | Size: 104 KiB |
|
After Width: | Height: | Size: 237 KiB |
|
After Width: | Height: | Size: 59 KiB |
|
After Width: | Height: | Size: 330 KiB |
|
After Width: | Height: | Size: 163 KiB |
|
After Width: | Height: | Size: 211 KiB |
|
After Width: | Height: | Size: 90 KiB |
|
After Width: | Height: | Size: 228 KiB |
|
After Width: | Height: | Size: 72 KiB |
|
After Width: | Height: | Size: 266 KiB |
|
After Width: | Height: | Size: 128 KiB |
|
After Width: | Height: | Size: 232 KiB |
|
After Width: | Height: | Size: 72 KiB |
|
After Width: | Height: | Size: 248 KiB |
|
After Width: | Height: | Size: 68 KiB |
|
After Width: | Height: | Size: 293 KiB |
|
After Width: | Height: | Size: 157 KiB |
|
After Width: | Height: | Size: 276 KiB |
|
After Width: | Height: | Size: 147 KiB |
|
After Width: | Height: | Size: 231 KiB |
|
After Width: | Height: | Size: 71 KiB |
|
After Width: | Height: | Size: 302 KiB |
|
After Width: | Height: | Size: 249 KiB |
|
After Width: | Height: | Size: 248 KiB |
@@ -0,0 +1,18 @@
|
|||||||
|
1) Capture screenshot
|
||||||
|
2) Open in GIMP 2.10
|
||||||
|
3) Select the area of interest
|
||||||
|
4) Copy the selection; take note of X, Y dimensions of the selection
|
||||||
|
5) "File" > "New"
|
||||||
|
- Add 100 extra pixels to X for the "Width"
|
||||||
|
- Add 100 extra pixels to Y for the "Height"
|
||||||
|
- Set "Fill with" to "Transparency"
|
||||||
|
6) Switch from the "Selection" tool to the "Move" tool and move the
|
||||||
|
the top-left corner of the image to 2 squares down and 2 squares across
|
||||||
|
7) Right-click the image and select "Layer" > "Anchor Layer"
|
||||||
|
8) "Filters" > "Decor" > "Light and Shadow" > "Drop Shadow"
|
||||||
|
- X = 20.0
|
||||||
|
- Y = 20.0
|
||||||
|
- Radius = 20.0
|
||||||
|
- Opacity = 0.2
|
||||||
|
|
||||||
|
|
||||||
|
Before Width: | Height: | Size: 39 KiB After Width: | Height: | Size: 62 KiB |
|
Before Width: | Height: | Size: 67 KiB After Width: | Height: | Size: 61 KiB |
|
Before Width: | Height: | Size: 69 KiB After Width: | Height: | Size: 94 KiB |
|
Before Width: | Height: | Size: 57 KiB After Width: | Height: | Size: 90 KiB |
|
After Width: | Height: | Size: 124 KiB |
|
After Width: | Height: | Size: 132 KiB |
|
After Width: | Height: | Size: 60 KiB |
|
After Width: | Height: | Size: 63 KiB |
|
After Width: | Height: | Size: 47 KiB |
|
After Width: | Height: | Size: 43 KiB |
|
After Width: | Height: | Size: 40 KiB |
|
Before Width: | Height: | Size: 31 KiB After Width: | Height: | Size: 54 KiB |
|
After Width: | Height: | Size: 20 KiB |
|
Before Width: | Height: | Size: 169 KiB After Width: | Height: | Size: 27 KiB |
|
Before Width: | Height: | Size: 86 KiB After Width: | Height: | Size: 91 KiB |
|
After Width: | Height: | Size: 142 KiB |
|
After Width: | Height: | Size: 167 KiB |
|
After Width: | Height: | Size: 140 KiB |
|
After Width: | Height: | Size: 154 KiB |
|
After Width: | Height: | Size: 142 KiB |
|
After Width: | Height: | Size: 157 KiB |
|
After Width: | Height: | Size: 143 KiB |
|
After Width: | Height: | Size: 172 KiB |
|
After Width: | Height: | Size: 149 KiB |
|
After Width: | Height: | Size: 179 KiB |
|
After Width: | Height: | Size: 157 KiB |
|
After Width: | Height: | Size: 181 KiB |
|
After Width: | Height: | Size: 174 KiB |
|
After Width: | Height: | Size: 199 KiB |
|
After Width: | Height: | Size: 161 KiB |
|
After Width: | Height: | Size: 190 KiB |
|
After Width: | Height: | Size: 162 KiB |
|
After Width: | Height: | Size: 190 KiB |
|
After Width: | Height: | Size: 162 KiB |
|
After Width: | Height: | Size: 192 KiB |
|
After Width: | Height: | Size: 190 KiB |
|
After Width: | Height: | Size: 213 KiB |
|
After Width: | Height: | Size: 204 KiB |
|
After Width: | Height: | Size: 225 KiB |
|
After Width: | Height: | Size: 153 KiB |
|
After Width: | Height: | Size: 183 KiB |
|
After Width: | Height: | Size: 162 KiB |
|
After Width: | Height: | Size: 190 KiB |
|
After Width: | Height: | Size: 179 KiB |
|
After Width: | Height: | Size: 204 KiB |
|
After Width: | Height: | Size: 220 KiB |
|
After Width: | Height: | Size: 233 KiB |
|
After Width: | Height: | Size: 91 KiB |
|
After Width: | Height: | Size: 105 KiB |
|
After Width: | Height: | Size: 526 KiB |
|
After Width: | Height: | Size: 478 KiB |
|
After Width: | Height: | Size: 81 KiB |
|
After Width: | Height: | Size: 93 KiB |
|
After Width: | Height: | Size: 432 KiB |
|
After Width: | Height: | Size: 86 KiB |
|
After Width: | Height: | Size: 95 KiB |
|
After Width: | Height: | Size: 78 KiB |
|
After Width: | Height: | Size: 57 KiB |
|
After Width: | Height: | Size: 325 KiB |
|
After Width: | Height: | Size: 106 KiB |
|
After Width: | Height: | Size: 118 KiB |
|
After Width: | Height: | Size: 328 KiB |
|
After Width: | Height: | Size: 326 KiB |
|
After Width: | Height: | Size: 324 KiB |
|
After Width: | Height: | Size: 496 KiB |
|
After Width: | Height: | Size: 538 KiB |
|
After Width: | Height: | Size: 326 KiB |