Skip to content
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

doc: rewrite TRC ceremony documentation to include scion-pki #4615

Merged
merged 5 commits into from
Sep 17, 2024
Merged
Show file tree
Hide file tree
Changes from 4 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -86,6 +86,7 @@ mocks:

gazelle: go_deps.bzl
bazel run //:gazelle --verbose_failures --config=quiet
./tools/buildrill/go_integration_test_sync

licenses:
tools/licenses.sh
Expand Down
2 changes: 1 addition & 1 deletion doc/command/scion-pki/scion-pki_trc.rst
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ SEE ALSO
* :ref:`scion-pki trc combine <scion-pki_trc_combine>` - Combine partially signed TRCs
* :ref:`scion-pki trc extract <scion-pki_trc_extract>` - Extract parts of a signed TRC
* :ref:`scion-pki trc format <scion-pki_trc_format>` - Reformat a TRC or TRC payload
* :ref:`scion-pki trc inspect <scion-pki_trc_inspect>` - Represent TRC in a human readable form
* :ref:`scion-pki trc inspect <scion-pki_trc_inspect>` - Print TRC details in a human readable format
* :ref:`scion-pki trc payload <scion-pki_trc_payload>` - Generate new TRC payload
* :ref:`scion-pki trc sign <scion-pki_trc_sign>` - Sign a TRC
* :ref:`scion-pki trc verify <scion-pki_trc_verify>` - Verify a TRC chain
Expand Down
8 changes: 4 additions & 4 deletions doc/command/scion-pki/scion-pki_trc_inspect.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,13 @@
scion-pki trc inspect
---------------------

Represent TRC in a human readable form
Print TRC details in a human readable format

Synopsis
~~~~~~~~


'human' outputs the TRC contents in a human readable form.
'inspect' prints the details of a TRC a human-readable fromat.

The input file can either be a TRC payload, or a signed TRC.
The output can either be in yaml, or json.
Expand All @@ -29,8 +29,8 @@ Examples

::

scion-pki trc human ISD1-B1-S1.pld.der
scion-pki trc human ISD1-B1-S1.trc
scion-pki trc inspect ISD1-B1-S1.pld.der
scion-pki trc inspect ISD1-B1-S1.trc

Options
~~~~~~~
Expand Down
51 changes: 29 additions & 22 deletions doc/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,9 @@

# -- Project information -----------------------------------------------------

project = 'SCION'
copyright = '2023, Anapaya Systems, ETH Zurich, SCION Association'
author = 'Anapaya Systems, ETH Zurich, SCION Association'
project = "SCION"
copyright = "2023, Anapaya Systems, ETH Zurich, SCION Association"
author = "Anapaya Systems, ETH Zurich, SCION Association"


# -- General configuration ---------------------------------------------------
Expand All @@ -18,32 +18,37 @@
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = [
'recommonmark',
'sphinx_rtd_theme',
'sphinx.ext.extlinks',
'sphinxcontrib.openapi',
'sphinx_copybutton',
"recommonmark",
"sphinx_copybutton",
"sphinx_design",
"sphinx_rtd_theme",
"sphinx.ext.extlinks",
"sphinxcontrib.openapi",
]

copybutton_prompt_text = r'\w*\$ ' # matches e.g. <hostname>$
copybutton_prompt_text = r"\w*\$ " # matches e.g. <hostname>$
copybutton_prompt_is_regexp = True
copybutton_only_copy_prompt_lines = True


# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
templates_path = ["_templates"]

# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
# This pattern also affects html_static_path and html_extra_path.
exclude_patterns = [
'venv', 'requirements.in', 'requirements.txt',
'_build', 'Thumbs.db', '.DS_Store',
'manuals/*/*', # manuals/<x>.rst uses "include" directive to compose files from subdirectories
'dev/design/TEMPLATE.rst',
"venv",
"requirements.in",
"requirements.txt",
"_build",
"Thumbs.db",
".DS_Store",
"manuals/*/*", # manuals/<x>.rst uses "include" directive to compose files from subdirectories
"dev/design/TEMPLATE.rst",
]

master_doc = 'index'
master_doc = "index"

nitpicky = True

Expand All @@ -55,25 +60,27 @@
# Note: somewhat obviously, these links will only work if the current rev has been pushed.
try:
file_ref_commit = subprocess.run(
['git', 'rev-parse', "HEAD"],
capture_output=True, text=True, check=True
["git", "rev-parse", "HEAD"], capture_output=True, text=True, check=True
).stdout.strip()
except subprocess.CalledProcessError:
file_ref_commit = "master" # only used on unexpected problem with executing git

extlinks = {
# :issue:`123` is an issue link displayed as "#123"
'issue': ('https://github.com/scionproto/scion/issues/%s', '#%s'),
"issue": ("https://github.com/scionproto/scion/issues/%s", "#%s"),
# :file-ref:`foo/bar.go` is a link to a file in the repo, displayed as "foo/bar.go"
'file-ref': ('https://github.com/scionproto/scion/blob/'+file_ref_commit+'/%s', '%s'),
"file-ref": (
"https://github.com/scionproto/scion/blob/" + file_ref_commit + "/%s",
"%s",
),
}

# -- Options for HTML output -------------------------------------------------

# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
#
html_theme = 'sphinx_rtd_theme'
html_theme = "sphinx_rtd_theme"

html_theme_options = dict(
style_external_links=True,
Expand All @@ -85,8 +92,8 @@
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['']
html_static_path = [""]

html_css_files = [
'css/custom.css',
"css/custom.css",
]
Loading
Loading