-
Notifications
You must be signed in to change notification settings - Fork 46
Use Sphinx to manage docs/latest/ #120
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| Sphinx == 4.4.0 | ||
| furo == 2022.3.4 | ||
| myst-parser == 0.17.0 |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,16 @@ | ||
| project = 'containerd' | ||
| templates_path = ['_templates'] | ||
| exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] | ||
| html_static_path = ['_static'] | ||
|
|
||
| # Same as our License header. | ||
| copyright = 'The contained Authors' | ||
| author = 'The containerd Authors' | ||
|
|
||
| # MyST (Markedly Structured Text) is a superset of CommonMark. | ||
| # https://myst-parser.readthedocs.io/en/latest/ | ||
| extensions = [ 'myst_parser' ] | ||
|
|
||
| # Uses Furo. | ||
| # https://github.com/pradyunsg/furo | ||
| html_theme = 'furo' |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,43 @@ | ||
| # containerd | ||
|
|
||
| TBD | ||
|
|
||
| ```{toctree} | ||
| :hidden: | ||
| :caption: Getting Started | ||
| ops.md | ||
| content-flow.md | ||
| garbage-collection.md | ||
| hosts.md | ||
| managed-opt.md | ||
| stream-processors.md | ||
| ``` | ||
|
|
||
| ```{toctree} | ||
| :hidden: | ||
| :caption: Advanced | ||
| namespaces.md | ||
| remote-snapshotter.md | ||
| tracing.md | ||
| rootless.md | ||
| ``` | ||
|
|
||
| ```{toctree} | ||
| :hidden: | ||
| :caption: Developing containerd client | ||
| getting-started.md | ||
| client-opts.md | ||
| ``` | ||
|
|
||
| ```{toctree} | ||
| :hidden: | ||
| :caption: CRI | ||
| cri/config.md | ||
| cri/crictl.md | ||
| cri/decryption.md | ||
| cri/installation.md | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This is outdated, being deprecated in containerd/containerd#6758 |
||
| cri/proposal.md | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This is historical (containerd/containerd#6754), no need to be linked here |
||
| cri/registry.md | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Outdated, not worth linking |
||
| cri/testing.md | ||
| cri/architecture.md | ||
| ``` | ||
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
For
docs/latest, we should have thisindex.mdand possiblyconf.pyin containerd/containerd.For released versions such as 1.6, I'd like to have versioned documents like https://www.envoyproxy.io/docs. However we generally backport only security fixes. So just using the existing branches wouldn't work.
Is it okay to backport documentation changes from
maintorelease/1.x?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes