Skip to content

Commit 8c62205

Browse files
cjdcordeirocjdcordeiro
authored
docs: add sphinx-docs-starter-pack base (#1)
1 parent 8637a98 commit 8c62205

29 files changed

+1097
-0
lines changed

‎docs/.custom_wordlist.txt‎

Whitespace-only changes.

‎docs/.readthedocs.yaml‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# .readthedocs.yaml
2+
# Read the Docs configuration file
3+
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
4+
5+
# Required
6+
version: 2
7+
8+
# Set the version of Python and other tools you might need
9+
build:
10+
os: ubuntu-22.04
11+
tools:
12+
python: "3.11"
13+
jobs:
14+
pre_install:
15+
- git fetch --unshallow || true
16+
17+
# Build documentation in the docs/ directory with Sphinx
18+
sphinx:
19+
builder: dirhtml
20+
configuration: docs/conf.py
21+
fail_on_warning: true
22+
23+
# If using Sphinx, optionally build your docs in additional formats such as PDF
24+
formats:
25+
- pdf
26+
27+
# Optionally declare the Python requirements required to build your docs
28+
python:
29+
install:
30+
- requirements: docs/.sphinx/requirements.txt

‎docs/.sphinx/.markdownlint.json‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
{
2+
"default": false,
3+
"MD003": { "style": "atx" },
4+
"MD013": { "code_blocks": false, "tables": false, "stern": true, "line_length": 150},
5+
"MD014": true,
6+
"MD018": true,
7+
"MD022": true,
8+
"MD023": true,
9+
"MD026": { "punctuation": ".,;。，；"},
10+
"MD031": { "list_items": false},
11+
"MD032": true,
12+
"MD035": true,
13+
"MD042": true,
14+
"MD045": true,
15+
"MD052": true
16+
}

‎docs/.sphinx/.wordlist.txt‎

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
ACME
2+
ACME's
3+
addons
4+
AGPLv
5+
API
6+
APIs
7+
balancer
8+
Charmhub
9+
CLI
10+
DCO
11+
Diátaxis
12+
Dqlite
13+
dropdown
14+
EBS
15+
EKS
16+
enablement
17+
favicon
18+
Furo
19+
Git
20+
GitHub
21+
Grafana
22+
IAM
23+
installable
24+
JSON
25+
Juju
26+
Kubeflow
27+
Kubernetes
28+
Launchpad
29+
linter
30+
LTS
31+
LXD
32+
Makefile
33+
Makefiles
34+
Matrix
35+
Mattermost
36+
MicroCeph
37+
MicroCloud
38+
MicroOVN
39+
MyST
40+
namespace
41+
namespaces
42+
NodePort
43+
Numbat
44+
observability
45+
OEM
46+
OLM
47+
Permalink
48+
pre
49+
Quickstart
50+
ReadMe
51+
reST
52+
reStructuredText
53+
roadmap
54+
RTD
55+
subdirectories
56+
subfolders
57+
subtree
58+
TODO
59+
Ubuntu
60+
UI
61+
UUID
62+
VM
63+
webhook
64+
YAML

‎docs/.sphinx/_static/css/pdf.css‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
/* Only relevant for specific PDF generation issues */
2+
3+
.rubric>.hclass2 {
4+
display: block;
5+
font-size: 2em;
6+
border-radius: .5rem;
7+
font-weight: 300;
8+
line-height: 1.25;
9+
margin-top: 1.75rem;
10+
margin-right: -0.5rem;
11+
margin-bottom: 0.5rem;
12+
margin-left: -0.5rem;
13+
padding-left: .5rem;
14+
padding-right: .5rem;
15+
}

‎docs/.sphinx/_static/favicon.png‎

2.21 KB
Loading

‎docs/.sphinx/_static/tag.png‎

6.62 KB
Loading

‎docs/.sphinx/_templates/header.html‎

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
<header id="header" class="p-navigation">
2+
3+
<div class="p-navigation__nav" role="menubar">
4+
5+
<ul class="p-navigation__links" role="menu">
6+
7+
<li>
8+
<a class="p-logo" href="https://{{ product_page }}" aria-current="page">
9+
<img src="{{ pathto(product_tag,1) }}" alt="Logo" class="p-logo-image">
10+
<div class="p-logo-text p-heading--4">{{ project }}
11+
</div>
12+
</a>
13+
</li>
14+
15+
<li class="nav-ubuntu-com">
16+
<a href="https://{{ product_page }}" class="p-navigation__link">{{ product_page }}</a>
17+
</li>
18+
19+
<li>
20+
<a href="#" class="p-navigation__link nav-more-links">More resources</a>
21+
<ul class="more-links-dropdown">
22+
23+
{% if discourse %}
24+
<li>
25+
<a href="{{ discourse }}" class="p-navigation__sub-link p-dropdown__link">Discourse</a>
26+
</li>
27+
{% endif %}
28+
29+
{% if mattermost %}
30+
<li>
31+
<a href="{{ mattermost }}" class="p-navigation__sub-link p-dropdown__link">Mattermost</a>
32+
</li>
33+
{% endif %}
34+
35+
{% if matrix %}
36+
<li>
37+
<a href="{{ matrix }}" class="p-navigation__sub-link p-dropdown__link">Matrix</a>
38+
</li>
39+
{% endif %}
40+
41+
{% if github_url %}
42+
<li>
43+
<a href="{{ github_url }}" class="p-navigation__sub-link p-dropdown__link">GitHub</a>
44+
</li>
45+
{% endif %}
46+
47+
</ul>
48+
</li>
49+
50+
</ul>
51+
</div>
52+
</header>

‎docs/.sphinx/fonts/LICENCE.txt‎

Lines changed: 96 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,96 @@
1+
-------------------------------
2+
UBUNTU FONT LICENCE Version 1.0
3+
-------------------------------
4+
5+
PREAMBLE
6+
This licence allows the licensed fonts to be used, studied, modified and
7+
redistributed freely. The fonts, including any derivative works, can be
8+
bundled, embedded, and redistributed provided the terms of this licence
9+
are met. The fonts and derivatives, however, cannot be released under
10+
any other licence. The requirement for fonts to remain under this
11+
licence does not require any document created using the fonts or their
12+
derivatives to be published under this licence, as long as the primary
13+
purpose of the document is not to be a vehicle for the distribution of
14+
the fonts.
15+
16+
DEFINITIONS
17+
"Font Software" refers to the set of files released by the Copyright
18+
Holder(s) under this licence and clearly marked as such. This may
19+
include source files, build scripts and documentation.
20+
21+
"Original Version" refers to the collection of Font Software components
22+
as received under this licence.
23+
24+
"Modified Version" refers to any derivative made by adding to, deleting,
25+
or substituting -- in part or in whole -- any of the components of the
26+
Original Version, by changing formats or by porting the Font Software to
27+
a new environment.
28+
29+
"Copyright Holder(s)" refers to all individuals and companies who have a
30+
copyright ownership of the Font Software.
31+
32+
"Substantially Changed" refers to Modified Versions which can be easily
33+
identified as dissimilar to the Font Software by users of the Font
34+
Software comparing the Original Version with the Modified Version.
35+
36+
To "Propagate" a work means to do anything with it that, without
37+
permission, would make you directly or secondarily liable for
38+
infringement under applicable copyright law, except executing it on a
39+
computer or modifying a private copy. Propagation includes copying,
40+
distribution (with or without modification and with or without charging
41+
a redistribution fee), making available to the public, and in some
42+
countries other activities as well.
43+
44+
PERMISSION & CONDITIONS
45+
This licence does not grant any rights under trademark law and all such
46+
rights are reserved.
47+
48+
Permission is hereby granted, free of charge, to any person obtaining a
49+
copy of the Font Software, to propagate the Font Software, subject to
50+
the below conditions:
51+
52+
1) Each copy of the Font Software must contain the above copyright
53+
notice and this licence. These can be included either as stand-alone
54+
text files, human-readable headers or in the appropriate machine-
55+
readable metadata fields within text or binary files as long as those
56+
fields can be easily viewed by the user.
57+
58+
2) The font name complies with the following:
59+
(a) The Original Version must retain its name, unmodified.
60+
(b) Modified Versions which are Substantially Changed must be renamed to
61+
avoid use of the name of the Original Version or similar names entirely.
62+
(c) Modified Versions which are not Substantially Changed must be
63+
renamed to both (i) retain the name of the Original Version and (ii) add
64+
additional naming elements to distinguish the Modified Version from the
65+
Original Version. The name of such Modified Versions must be the name of
66+
the Original Version, with "derivative X" where X represents the name of
67+
the new work, appended to that name.
68+
69+
3) The name(s) of the Copyright Holder(s) and any contributor to the
70+
Font Software shall not be used to promote, endorse or advertise any
71+
Modified Version, except (i) as required by this licence, (ii) to
72+
acknowledge the contribution(s) of the Copyright Holder(s) or (iii) with
73+
their explicit written permission.
74+
75+
4) The Font Software, modified or unmodified, in part or in whole, must
76+
be distributed entirely under this licence, and must not be distributed
77+
under any other licence. The requirement for fonts to remain under this
78+
licence does not affect any document created using the Font Software,
79+
except any version of the Font Software extracted from a document
80+
created using the Font Software may only be distributed under this
81+
licence.
82+
83+
TERMINATION
84+
This licence becomes null and void if any of the above conditions are
85+
not met.
86+
87+
DISCLAIMER
88+
THE FONT SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
89+
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTIES OF
90+
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT OF
91+
COPYRIGHT, PATENT, TRADEMARK, OR OTHER RIGHT. IN NO EVENT SHALL THE
92+
COPYRIGHT HOLDER BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
93+
INCLUDING ANY GENERAL, SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL
94+
DAMAGES, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
95+
FROM, OUT OF THE USE OR INABILITY TO USE THE FONT SOFTWARE OR FROM OTHER
96+
DEALINGS IN THE FONT SOFTWARE.

‎docs/.sphinx/fonts/Ubuntu-B.ttf‎

326 KB
Binary file not shown.

0 commit comments

Comments
 (0)