From 68fa904da4f2af1e5a9f20939ead6278c1d2eafd Mon Sep 17 00:00:00 2001 From: Bart Vanbrabant Date: Mon, 20 Jun 2022 20:40:05 +0200 Subject: [PATCH] This adds a space between the type and the attribute. Without the space will not always render (Issue inmanta/inmanta-sphinx#52, PR #4390) # Description Validated against build closes inmanta/inmanta-sphinx#52 # Self Check: Strike through any lines that are not applicable (`~~line~~`) then check the box - [ ] Attached issue to pull request - [ ] Changelog entry - [ ] Type annotations are present - [ ] Code is clear and sufficiently documented - [ ] No (preventable) type errors (check using make mypy or make mypy-diff) - [ ] Sufficient test cases (reproduces the bug/tests the requested feature) - [ ] Correct, in line with design - [ ] End user documentation is included or an issue is created for end-user documentation (add ref to issue here: ) # Reviewer Checklist: - [ ] Sufficient test cases (reproduces the bug/tests the requested feature) - [ ] Code is clear and sufficiently documented - [ ] Correct, in line with design --- changelogs/unreleased/fix-docs-spacing.yml | 5 +++++ docs/_static/css/custom.css | 4 ++++ docs/conf.py | 4 ++++ 3 files changed, 13 insertions(+) create mode 100644 changelogs/unreleased/fix-docs-spacing.yml create mode 100644 docs/_static/css/custom.css diff --git a/changelogs/unreleased/fix-docs-spacing.yml b/changelogs/unreleased/fix-docs-spacing.yml new file mode 100644 index 0000000000..4214b3b8a5 --- /dev/null +++ b/changelogs/unreleased/fix-docs-spacing.yml @@ -0,0 +1,5 @@ +description: This adds a space between the type and the attribute. Without the space will not always render +issue-nr: 52 +issue-repo: inmanta-sphinx +change-type: patch +destination-branches: [master, iso5, iso4] diff --git a/docs/_static/css/custom.css b/docs/_static/css/custom.css new file mode 100644 index 0000000000..159c39d434 --- /dev/null +++ b/docs/_static/css/custom.css @@ -0,0 +1,4 @@ +/* This adds a space between the type and the attribute. Without the space will not always render */ +dl.attribute .sig-prename { + margin-left: 0.5em; +} diff --git a/docs/conf.py b/docs/conf.py index 6ad6708451..278fef9386 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -210,6 +210,10 @@ def setup(app): # Output file base name for HTML help builder. htmlhelp_basename = 'InmantaDoc' +html_css_files = [ + 'css/custom.css', +] + # -- Options for LaTeX output --------------------------------------------------