Skip to content

Commit b474949

Browse files
author
Kazuyoshi Kato
committed
Use Sphinx to manage docs/latest/
This commit adds https://containerd.io/docs/latest/, based on github.com/containerd/containerd's docs directory. We would need docs/1.6/, docs/1.5/, ... eventually. But for now we can start from the tip of the main branch. Signed-off-by: Kazuyoshi Kato <katokazu@amazon.com>
1 parent 98d6e9b commit b474949

File tree

5 files changed

+73
-2
lines changed

5 files changed

+73
-2
lines changed

Makefile

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,11 +21,17 @@ serve:
2121
--buildFuture \
2222
--disableFastRender
2323

24-
production-build:
24+
public/docs/latest:
25+
mkdir -p $@ tmp
26+
git clone --depth 1 https://github.com/containerd/containerd.git tmp/containerd
27+
mv sphinx/* tmp/containerd/docs/
28+
sphinx-build tmp/containerd/docs public/docs/latest
29+
30+
production-build: public/docs/latest
2531
hugo \
2632
--minify
2733

28-
preview-build:
34+
preview-build: public/docs/latest
2935
hugo \
3036
--baseURL $(DEPLOY_PRIME_URL) \
3137
--buildDrafts \

netlify.toml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ command = "make production-build"
44

55
[build.environment]
66
HUGO_VERSION = "0.65.3"
7+
PYTHON_VERSION = "3.7"
78

89
[context.deploy-preview]
910
command = "make preview-build"

requirements.txt

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
Sphinx == 4.4.0
2+
furo == 2022.3.4
3+
myst-parser == 0.17.0
4+

sphinx/conf.py

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
project = 'containerd'
2+
templates_path = ['_templates']
3+
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
4+
html_static_path = ['_static']
5+
6+
# Same as our License header.
7+
copyright = 'The contained Authors'
8+
author = 'The containerd Authors'
9+
10+
# MyST (Markedly Structured Text) is a superset of CommonMark.
11+
# https://myst-parser.readthedocs.io/en/latest/
12+
extensions = [ 'myst_parser' ]
13+
14+
# Uses Furo.
15+
# https://github.com/pradyunsg/furo
16+
html_theme = 'furo'
17+

sphinx/index.md

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
# containerd
2+
3+
TBD
4+
5+
```{toctree}
6+
:hidden:
7+
:caption: Getting Started
8+
ops.md
9+
content-flow.md
10+
garbage-collection.md
11+
hosts.md
12+
managed-opt.md
13+
stream-processors.md
14+
```
15+
16+
```{toctree}
17+
:hidden:
18+
:caption: Advanced
19+
namespaces.md
20+
remote-snapshotter.md
21+
tracing.md
22+
rootless.md
23+
```
24+
25+
```{toctree}
26+
:hidden:
27+
:caption: Developing containerd client
28+
getting-started.md
29+
client-opts.md
30+
```
31+
32+
```{toctree}
33+
:hidden:
34+
:caption: CRI
35+
cri/config.md
36+
cri/crictl.md
37+
cri/decryption.md
38+
cri/installation.md
39+
cri/proposal.md
40+
cri/registry.md
41+
cri/testing.md
42+
cri/architecture.md
43+
```

0 commit comments

Comments
 (0)