Merge pull request #694 from girder/improve-docs

Add annotation schema to Sphinx docs
girder · Nov 29, 2021 · fce2e24 · fce2e24
2 parents b0763e1 + ded0749
commit fce2e24
Show file tree

Hide file tree

Showing 11 changed files with 384 additions and 327 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,10 @@
 # Change Log
 
+## Unreleased
+
+### Changes
+- Some log levels have been adjusted ([#689](../../pull/689))
+
 ## Version 1.8.7
 
 ### Improvements

diff --git a/docs/source/annotations.rst b/docs/source/annotations.rst
@@ -0,0 +1 @@
+.. include:: ../../girder_annotation/docs/annotations.rst
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -66,6 +66,7 @@
 # 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 = ['static']
+html_css_files = ['custom.css']
 
 autoclass_content = 'both'
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -34,11 +34,12 @@ large_image also works as a Girder plugin with optional annotation support.
    large_image_tasks/modules
    girder_large_image/modules
    girder_large_image_annotation/modules
+   annotations
+
 
 
 Indices and tables
 ==================
 
 * :ref:`genindex`
 * :ref:`modindex`
-* :ref:`search`
diff --git a/docs/source/static/custom.css b/docs/source/static/custom.css
@@ -0,0 +1,10 @@
+.indextable.genindextable td {
+  padding-right: 10px
+}
+.indextable.genindextable li {
+  word-break: break-word;
+}
+.indextable.genindextable a:before {
+  content: "\2022\00A0";
+}
+
diff --git a/girder_annotation/docs/annotations.md b/girder_annotation/docs/annotations.md
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		.. include:: ../../girder_annotation/docs/annotations.rst