From 364c1214e34458148790fa05681bf13c9e5153d3 Mon Sep 17 00:00:00 2001 From: David Erb Date: Wed, 31 May 2023 16:19:01 +0100 Subject: [PATCH] fixes docs --- README.md | 8 ++++++++ README.rst | 44 -------------------------------------------- docs/api/classes.rst | 2 +- docs/index.rst | 2 -- 4 files changed, 9 insertions(+), 47 deletions(-) create mode 100644 README.md delete mode 100644 README.rst diff --git a/README.md b/README.md new file mode 100644 index 0000000..0bbe9fb --- /dev/null +++ b/README.md @@ -0,0 +1,8 @@ +dls-servbase +======================================================================= + +Simple HTTP service for database operations. + +Agnostic of type of underlying sql client, provides single-writer access to native database and has a predefined database schema for cookies. + +For documentation see: https://diamondlightsource.github.io/dls-servbase \ No newline at end of file diff --git a/README.rst b/README.rst deleted file mode 100644 index 54373b6..0000000 --- a/README.rst +++ /dev/null @@ -1,44 +0,0 @@ -dls-servbase -======================================================================= - -Simple HTTP service for database operations. - -Intended advantages: - -- agnostic of type of underlying sql client -- single-connection access to database -- hosts a few predefined common database schema - -Installation ------------------------------------------------------------------------ -:: - - pip install git+https://gitlab.diamond.ac.uk/kbp43231/dls-servbase.git - - dls-servbase --version - -Documentation ------------------------------------------------------------------------ - -See https://www.cs.diamond.ac.uk/dls-servbase for more detailed documentation. - -Building and viewing the documents locally:: - - git clone git+https://gitlab.diamond.ac.uk/kbp43231/dls-servbase.git - cd dls-servbase - virtualenv /scratch/$USER/venv/dls-servbase - source /scratch/$USER/venv/dls-servbase/bin/activate - pip install -e .[dev] - make -f .dls-servbase/Makefile validate_docs - browse to file:///scratch/$USER/venvs/dls-servbase/build/html/index.html - -Topics for further documentation: - -- TODO list of improvements -- change log - - -.. - Anything below this line is used when viewing README.rst and will be replaced - when included in index.rst - diff --git a/docs/api/classes.rst b/docs/api/classes.rst index ecc6372..9ca2c03 100644 --- a/docs/api/classes.rst +++ b/docs/api/classes.rst @@ -1,4 +1,4 @@ Classes ======================================================================= -.. autoclass:: dls_servbase_lib.databases.databases.Databases +.. autoclass:: dls_servbase_lib.datafaces.datafaces.Datafaces :members: diff --git a/docs/index.rst b/docs/index.rst index e56f665..e328032 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,6 +1,4 @@ -.. include:: ../README.rst - :end-before: when included in index.rst .. toctree:: :caption: API-caption