Merge pull request #148 from UCL/update-docs

Update docs to new standard
SciKit-Surgery · Aug 4, 2020 · a6c9193 · a6c9193
2 parents 6cff327 + e86f880
commit a6c9193
Show file tree

Hide file tree

Showing 18 changed files with 44 additions and 22 deletions.
diff --git a/README.rst b/README.rst
@@ -1,12 +1,14 @@
 scikit-surgeryvtk
 ===============================
 
-.. image:: https://github.com/UCL/scikit-surgeryvtk /raw/master/project-icon.png
+.. image:: https://github.com/UCL/scikit-surgeryvtk /raw/master/weiss_logo.png
    :height: 128px
    :width: 128px
    :target: https://github.com/UCL/scikit-surgeryvtk 
    :alt: Logo
 
+|
+
 .. image:: https://github.com/UCL/scikit-surgeryvtk/workflows/.github/workflows/ci.yml/badge.svg
    :target: https://github.com/UCL/scikit-surgeryvtk/actions
    :alt: GitHub Actions CI statuss
@@ -23,6 +25,8 @@ scikit-surgeryvtk implements VTK for Image Guided Surgery applications.
 
 scikit-surgeryvtk is part of the `SNAPPY`_ software project, developed at the `Wellcome EPSRC Centre for Interventional and Surgical Sciences`_, part of `University College London (UCL)`_.
 
+.. features-start
+
 Features
 --------
 Functionality includes:
@@ -32,6 +36,8 @@ Functionality includes:
 * Functions for working with calibrated cameras, and projecting points from 3D to 2D.
 * A widget to drive a stereo interlaced monitor.
 
+.. features-end
+
 Installing
 ~~~~~~~~~~
 

diff --git a/doc/index.rst b/doc/index.rst
diff --git a/doc/.gitignore → docs/.gitignore b/doc/.gitignore → docs/.gitignore
diff --git a/doc/camera/index.rst → docs/camera/index.rst b/doc/camera/index.rst → docs/camera/index.rst
diff --git a/doc/conf.py → docs/conf.py b/doc/conf.py → docs/conf.py
@@ -30,7 +30,7 @@
 root_dir_abs = os.path.abspath(root_dir_rel)
 module_path = root_dir_abs
 sys.path.insert(0, module_path)
-logo_file = 'project-icon.png'
+logo_file = 'weiss_logo.png'
 logo_path = os.path.join('..', logo_file)
 
 # List of patterns, relative to source directory, that match files and

diff --git a/docs/index.rst b/docs/index.rst
@@ -0,0 +1,34 @@
+scikit-surgeryvtk documentation
+===============================
+
+.. include:: ../README.rst
+   :start-after: .. features-start
+   :end-before: .. features-end
+
+`Source code <https://github.com/UCL/scikit-surgeryvtk/>`_ is avaialble on GitHub.
+
+.. toctree::
+  :maxdepth: 2
+
+  readme
+
+.. toctree::
+  :caption: Module Reference
+  :maxdepth: 2
+
+  widgets/index
+  models/index
+  camera/index
+  text/index
+  utils/index
+
+.. toctree::
+  :glob:
+  :maxdepth: 1
+  :caption: Tutorials
+
+  tutorials/*
+
+
+
+
diff --git a/doc/models/index.rst → docs/models/index.rst b/doc/models/index.rst → docs/models/index.rst
diff --git a/doc/overlay_window.png → docs/overlay_window.png b/doc/overlay_window.png → docs/overlay_window.png
diff --git a/docs/readme.rst b/docs/readme.rst
@@ -0,0 +1,2 @@
+
+.. include:: ../README.rst
diff --git a/doc/requirements.rst → docs/requirements.rst b/doc/requirements.rst → docs/requirements.rst
diff --git a/doc/static/.gitkeep → docs/static/.gitkeep b/doc/static/.gitkeep → docs/static/.gitkeep
diff --git a/doc/static/custom.css → docs/static/custom.css b/doc/static/custom.css → docs/static/custom.css
diff --git a/doc/text/index.rst → docs/text/index.rst b/doc/text/index.rst → docs/text/index.rst
diff --git a/doc/overlay_widget.rst → docs/tutorials/overlay_widget.rst b/doc/overlay_widget.rst → docs/tutorials/overlay_widget.rst
diff --git a/doc/utils/index.rst → docs/utils/index.rst b/doc/utils/index.rst → docs/utils/index.rst
diff --git a/doc/widgets/index.rst → docs/widgets/index.rst b/doc/widgets/index.rst → docs/widgets/index.rst
diff --git a/project-icon.png b/project-icon.png
diff --git a/weiss_logo.png b/weiss_logo.png