Skip to content

Commit b0b415c

Browse files
Update landing pages and tooling (14) (#1645)
* update home page * add missing heading * update starter pack version to 1.6 * update how-to landing page * update reference landing page * update explanation landing page * fix spelling errors * Update docs/reference/index.md Co-authored-by: Marcelo Henrique Neppel <marcelo.neppel@canonical.com> Signed-off-by: Andreia <andreia.velasco@canonical.com> * fix copyright and license information --------- Signed-off-by: Andreia <andreia.velasco@canonical.com> Co-authored-by: Marcelo Henrique Neppel <marcelo.neppel@canonical.com>
1 parent 16730dc commit b0b415c

21 files changed

Lines changed: 622 additions & 1047 deletions

.readthedocs.yaml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ build:
1818
# This is a special exit code on Read the Docs that will cancel the build immediately.
1919
# https://docs.readthedocs.io/en/stable/build-customization.html#cancel-build-based-on-a-condition
2020
- |
21-
if [ "$READTHEDOCS_VERSION_TYPE" = "external" ] && git diff --quiet origin/14/docs -- 'docs/' '.readthedocs.yaml';
21+
if [ "$READTHEDOCS_VERSION_TYPE" = "external" ] && git diff --quiet origin/main -- 'docs/' '.readthedocs.yaml';
2222
then
2323
exit 183;
2424
fi
@@ -30,8 +30,8 @@ sphinx:
3030
fail_on_warning: true
3131

3232
# If using Sphinx, optionally build your docs in additional formats such as PDF
33-
# formats:
34-
# - pdf
33+
formats:
34+
- pdf
3535

3636
# Optionally declare the Python requirements required to build your docs
3737
python:

docs/.gitignore

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Environment
22
*env*/
3-
.sphinx/venv/
3+
.venv/
44

55
# Sphinx
66
.sphinx/warnings.txt

docs/.sphinx/.pymarkdown.json

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
{
2+
"plugins": {
3+
"selectively_enable_rules": true,
4+
"heading-style": {
5+
"enabled": true,
6+
"style": "atx"
7+
},
8+
"commands-show-output": {
9+
"enabled": true
10+
},
11+
"no-missing-space-atx": {
12+
"enabled": true
13+
},
14+
"blanks-around-headings": {
15+
"enabled": true
16+
},
17+
"heading-start-left": {
18+
"enabled": true
19+
},
20+
"no-trailing-punctuation": {
21+
"enabled": true,
22+
"punctuation": ".,;。,;"
23+
},
24+
"blanks-around-fences": {
25+
"enabled": true,
26+
"list_items": false
27+
},
28+
"blanks-around-lists": {
29+
"enabled": true
30+
},
31+
"hr-style": {
32+
"enabled": true
33+
},
34+
"no-empty-links": {
35+
"enabled": true
36+
},
37+
"no-alt-text": {
38+
"enabled": true
39+
}
40+
},
41+
"extensions": {
42+
"front-matter" : {
43+
"enabled" : true
44+
}
45+
}
46+
}

0 commit comments

Comments
 (0)