Fix documentation pages

fabcor-maxiv · Sep 22, 2023 · 6c3addc · 6c3addc
1 parent 9cc9e9e
commit 6c3addc
Show file tree

Hide file tree

Showing 19 changed files with 90 additions and 70 deletions.
diff --git a/docs/source/Beamline.rst b/docs/source/Beamline.rst
diff --git a/docs/source/Collection.rst b/docs/source/Collection.rst
diff --git a/docs/source/Queue.rst b/docs/source/Queue.rst
diff --git a/docs/source/Sample.rst b/docs/source/Sample.rst
diff --git a/docs/source/SampleCentring.rst b/docs/source/SampleCentring.rst
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -12,18 +12,22 @@
 # All configuration values have a default; values that are commented out
 # serve to show the default.
 
-import sys
-import os
-import shlex
+import datetime
+# TODO import os
+# TODO import sys
+
+import mxcube3
+
+mxcube3.build_server_and_config(argv=[])
 
 # If extensions (or modules to document with autodoc) are in another directory,
 # add these directories to sys.path here. If the directory is relative to the
 # documentation root, use os.path.abspath to make it absolute, like shown here.
 # sys.path.insert(0, os.path.abspath('.'))
-sys.path.append(os.path.abspath("../../"))
-sys.path.append(os.path.abspath("../../mxcube3/"))
-sys.path.append(os.path.abspath("../../mxcube3/HardwareObjects"))
-sys.path.append(os.path.abspath("../../mxcube3/HardwareRepository"))
+# TODO sys.path.append(os.path.abspath("../../"))
+# TODO sys.path.append(os.path.abspath("../../mxcube3/"))
+# TODO sys.path.append(os.path.abspath("../../mxcube3/HardwareObjects"))
+# TODO sys.path.append(os.path.abspath("../../mxcube3/HardwareRepository"))
 
 # -- General configuration ------------------------------------------------
 
@@ -55,12 +59,12 @@
 # source_encoding = 'utf-8-sig'
 
 # The master toctree document.
-master_doc = "index"
+master_doc = "contents"
 
 # General information about the project.
-project = u"MXCuBE3"
-copyright = u"2015, MXCuBE Collaboration"
-author = u"MXCuBE Collaboration"
+project = "MXCuBE web"
+copyright = f"{datetime.datetime.today().year}, MXCuBE Collaboration"
+author = "MXCuBE Collaboration"
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
@@ -76,7 +80,7 @@
 #
 # This is also used if you do content translation via gettext catalogs.
 # Usually you set "language" from the command line for these cases.
-language = None
+language = "en"
 
 # There are two options for replacing |today|: either, you set today to some
 # non-false value, then it is used:
@@ -149,7 +153,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 = ["_static"]
+# html_static_path = ["_static"]
 
 # Add any extra paths that contain custom files (such as robots.txt or
 # .htaccess) here, relative to this directory. These files are copied

diff --git a/docs/source/contents.rst b/docs/source/contents.rst
@@ -0,0 +1,12 @@
+#################
+Table of contents
+#################
+
+Contents:
+
+.. toctree::
+    :glob:
+
+    *
+    dev/index
+    rest-api/index
diff --git a/docs/source/dev/index.rst b/docs/source/dev/index.rst
@@ -0,0 +1,8 @@
+#######################
+Developer documentation
+#######################
+
+.. toctree::
+    :glob:
+
+    *
diff --git a/docs/source/Login.rst → docs/source/dev/login.rst b/docs/source/Login.rst → docs/source/dev/login.rst
@@ -1,5 +1,6 @@
+*****
 Login
-=====
+*****
 
 MXCuBE web sessions are meant to expire when there is no activity,
 as opposed to a typical web session that expires when the browser is closed.
@@ -23,10 +24,3 @@ Every time the *refresh* endpoint is called,
 the browser session cookie is refreshed,
 meaning its expiration timestamp is pushed back in the future
 for as much as the value stored in ``PERMANENT_SESSION_LIFETIME``.
-
-
-Login API
----------
-
-.. autoflask:: mxcube3.routes.Login:mxcube
-    :endpoints: login, signout, loginInfo, get_initial_state, proposal_samples
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -1,17 +1,3 @@
-.. MXCuBE3 documentation master file, created by
-   sphinx-quickstart on Tue Nov 10 16:07:35 2015.
-   You can adapt this file completely to your liking, but it should at least
-   contain the root `toctree` directive.
-
-Welcome to MXCuBE3's documentation!
-===================================
-
-Contents:
-
-	.. toctree::
-   		:maxdepth: 2
-
-		SampleCentring
-		Queue
-                Login
-
+##########
+MXCuBE web
+##########
diff --git a/docs/source/rest-api/beamline.rst b/docs/source/rest-api/beamline.rst
@@ -0,0 +1,5 @@
+Beamline REST API
+=================
+
+.. autoflask:: mxcube3:server.flask
+    :blueprints: beamline
diff --git a/docs/source/rest-api/detector.rst b/docs/source/rest-api/detector.rst
@@ -0,0 +1,5 @@
+Detector REST API
+=================
+
+.. autoflask:: mxcube3:server.flask
+    :blueprints: detector
diff --git a/docs/source/rest-api/diffractometer.rst b/docs/source/rest-api/diffractometer.rst
@@ -0,0 +1,5 @@
+Diffractometer REST API
+=======================
+
+.. autoflask:: mxcube3:server.flask
+    :blueprints: diffractometer
diff --git a/docs/source/rest-api/index.rst b/docs/source/rest-api/index.rst
@@ -0,0 +1,8 @@
+########
+REST API
+########
+
+.. toctree::
+    :glob:
+
+    *
diff --git a/docs/source/rest-api/lims.rst b/docs/source/rest-api/lims.rst
@@ -0,0 +1,5 @@
+LIMS REST API
+=============
+
+.. autoflask:: mxcube3:server.flask
+    :blueprints: lims
diff --git a/docs/source/rest-api/login.rst b/docs/source/rest-api/login.rst
@@ -0,0 +1,5 @@
+Login REST API
+==============
+
+.. autoflask:: mxcube3:server.flask
+    :blueprints: login
diff --git a/docs/source/rest-api/queue.rst b/docs/source/rest-api/queue.rst
@@ -0,0 +1,5 @@
+Queue REST API
+==============
+
+.. autoflask:: mxcube3:server.flask
+    :blueprints: queue
diff --git a/docs/source/rest-api/remote-access.rst b/docs/source/rest-api/remote-access.rst
@@ -0,0 +1,5 @@
+Remote access REST API
+======================
+
+.. autoflask:: mxcube3:server.flask
+    :blueprints: remote_access
diff --git a/docs/source/rest-api/sample-view.rst b/docs/source/rest-api/sample-view.rst
@@ -0,0 +1,5 @@
+Sample view REST API
+====================
+
+.. autoflask:: mxcube3:server.flask
+    :blueprints: sampleview