diff --git a/.github/workflows/doc-build.yaml b/.github/workflows/doc-build.yaml index e306d41..74a28ff 100644 --- a/.github/workflows/doc-build.yaml +++ b/.github/workflows/doc-build.yaml @@ -17,8 +17,7 @@ jobs: docs-folder: "src_docs/" pre-build-command: | pip install sphinx_rtd_theme - pip install sphinx-bootstrap-theme - pip install renku-sphinx-theme + pip install furo build-command: "sphinx-build -b html ./source ../docs" - name: Commit documentation changes diff --git a/html/device.htm b/html/device.htm index 12f7a68..7dad2be 100644 --- a/html/device.htm +++ b/html/device.htm @@ -100,7 +100,7 @@ $('#spinner').show(); $.getJSON(url, function (cfg) { console.log( cfg ); - $("#app-ver").text(cfg["app-ver"] + " (html 0.5.0)"); + $("#app-ver").text(cfg["app-ver"] + " (html 0.6.0)"); $("#mdns").text(cfg["mdns"]); $("#id").text(cfg["id"]); }) diff --git a/html/device.min.htm b/html/device.min.htm index 228c59f..af7f532 100644 --- a/html/device.min.htm +++ b/html/device.min.htm @@ -1 +1 @@ -Beer Gravity Monitor

Current version:
Loading...
Host name:
Loading...
Device ID:
Loading...

(C) Copyright 2021-22 Magnus Persson
\ No newline at end of file +Beer Gravity Monitor

Current version:
Loading...
Host name:
Loading...
Device ID:
Loading...

(C) Copyright 2021-22 Magnus Persson
\ No newline at end of file diff --git a/src_docs/source/backlog.rst b/src_docs/source/backlog.rst index e321c87..50e94db 100644 --- a/src_docs/source/backlog.rst +++ b/src_docs/source/backlog.rst @@ -9,6 +9,5 @@ Documentation Code ------------- -- Support for MQTT - Support for plato - Use pre-commit for validating check-in diff --git a/src_docs/source/conf.py b/src_docs/source/conf.py index 01d061e..41a5a22 100644 --- a/src_docs/source/conf.py +++ b/src_docs/source/conf.py @@ -22,7 +22,7 @@ copyright = '2021-2022, Magnus Persson' author = 'Magnus Persson' # The full version, including alpha/beta/rc tags -release = '0.5.0' +release = '0.6.0' # -- General configuration --------------------------------------------------- @@ -41,21 +41,17 @@ templates_path = ['_templates'] # This pattern also affects html_static_path and html_extra_path. exclude_patterns = [] - # -- Options for HTML output ------------------------------------------------- # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. # -html_theme = 'renku' - -#html_theme = 'sphinx_rtd_theme' - -#import sphinx_bootstrap_theme -#html_theme = 'bootstrap' -#html_theme_path = sphinx_bootstrap_theme.get_html_theme_path() +html_theme = 'furo' # 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'] \ No newline at end of file +html_static_path = ['_static'] + +html_show_sourcelink = False +html_show_sphinx = True diff --git a/src_docs/source/index.rst b/src_docs/source/index.rst index 4226876..b61cb97 100644 --- a/src_docs/source/index.rst +++ b/src_docs/source/index.rst @@ -7,7 +7,7 @@ Welcome to GravityMon's documentation! ###################################### .. note:: - This documentation reflects **v0.6**. Last updated 2022-01-11 + This documentation reflects **v0.6**. Last updated 2022-01-13 GravityMon is a replacement firmare for the iSpindle firmware, it uses the same hardware configuration so diff --git a/src_docs/source/styling.rst b/src_docs/source/styling.rst deleted file mode 100644 index de1ef4e..0000000 --- a/src_docs/source/styling.rst +++ /dev/null @@ -1,58 +0,0 @@ -Testing formatting ------------------- - -Header 1 -######## - -Header 2 --------- - -Header 3 -******** - -**BOLD** - -*ITALIC* - -``CODE SAMPLE`` - -1. List -2. List - -* List -* List - -.. list-table:: Table - :widths: 40 60 - :header-rows: 1 - - * - table - - table - * - content - - content - -.. image:: images/formula1.png - :width: 400 - :alt: image - -.. code-block:: objdump - - measurement,host=,device=,temp-format=,gravity-format=SG,gravity=1.0004,corr-gravity=1.0004,angle=45.45,temp=20.1,battery=3.96,rssi=-18 - -.. code-block:: json - - { - "project":"gravmon", - "version":"0.4.10", - "html": [ - "index.min.htm", - "device.min.htm", - "config.min.htm", - "calibration.min.htm", - "about.min.htm" - ] - } - -.. note:: - - Note...