diff --git a/docs/_source/installation.rst b/docs/_source/installation.rst new file mode 100644 index 0000000000000000000000000000000000000000..8f221c34b852d9efae1f8afdd18569779d3f88d9 --- /dev/null +++ b/docs/_source/installation.rst @@ -0,0 +1,12 @@ +.. ews-plotting documentation master file, created by + sphinx-quickstart on Thu May 25 13:28:43 2023. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +Installation +============ + +.. _installation_label: + +To install the package, do stuff + diff --git a/docs/_static/css/extra.css b/docs/_static/css/extra.css new file mode 100644 index 0000000000000000000000000000000000000000..82a8e6b4285228ae76e384c8a47e43ac64a91a3e --- /dev/null +++ b/docs/_static/css/extra.css @@ -0,0 +1,4 @@ +.wy-nav-content { + max-width: 1200px !important; + +.not_full_screen {background: red;width: 100%;height: 700px;} \ No newline at end of file diff --git a/docs/conf.py b/docs/conf.py index 64e1d2508bbfd6f665106ba8eb34226724fdb1c4..56a9b2d806cd2316f3c6c317db96180ba3f4d1c0 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -55,6 +55,7 @@ if not on_rtd: # only import and set the theme if we're building docs locally html_css_files = ["readthedocs-custom.css"] # Override some CSS settings # html_theme = 'alabaster' +html_static_path = ['_static'] # # This is the expected signature of the handler for this event, cf doc # def autodoc_skip_member_handler(app, what, name, obj, skip, options): @@ -68,3 +69,6 @@ html_css_files = ["readthedocs-custom.css"] # Override some CSS settings # # Connect the autodoc-skip-member event from apidoc to the callback # app.connect('autodoc-skip-member', autodoc_skip_member_handler) + +def setup(app): + app.add_css_file('css/extra.css') \ No newline at end of file diff --git a/docs/index.rst b/docs/index.rst index 211b359876474a4324b8fdd8feaeb656461d90df..da8fe331fbb6d260c107b2b64f91bc3e9a527516 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -6,24 +6,48 @@ Welcome to ews-plotting's documentation! ======================================== +for sections +============ + +for subsections +--------------- + +for subsubsections +^^^^^^^^^^^^^^^^^^ + +for paragraphs +"""""""""""""" .. toctree:: :hidden: Home page <self> + Installation <_source/installation> coordinator API <_autosummary/coordinator> plotting API <_autosummary/plotting> post processing API <_autosummary/ews_postprocessing> met processing processing API <_autosummary/met_processing> source gen API <_autosummary/source_gen> +.. admonition:: Box thingy + + This is a box thingy -Indices and tables -================== +Example of inline code links +---------------------------- -this is is a load of ``text`` that has ``plotting.common.utils`` this function in it +this is is a load of ``text`` that has ``plotting.common.utils`` this function in it. + +and this should be on a new line .. autosummary:: plotting.common.utils.build_standard_depo_diseases ews_postprocessing.deposition.NAME_to_csv.NAMEToCSV +Installation instructions +------------------------- + +A quickstart on installation can be found in: :doc:`_source/installation`. + +And here I am refering to it again but using a page :ref:`label<installation_label>` +