diff --git a/docs/source/_static/css/cb_theme.css b/docs/source/_static/css/cb_theme.css index 9266f45..9d5e7a5 100644 --- a/docs/source/_static/css/cb_theme.css +++ b/docs/source/_static/css/cb_theme.css @@ -30,8 +30,28 @@ body { line-height: 1.5 !important; } -.document .bodywrapper .body p span.caption-text { - font-size: 30px !important; +.document .bodywrapper .body p.caption, +.document .bodywrapper .body caption, +.document .bodywrapper .body span.caption-number, +.document .bodywrapper .body span.caption-text { + font-size: 18px !important; + line-height: 1.5 !important; +} + +.document .bodywrapper .body figure figcaption, +.document .bodywrapper .body figure figcaption p, +.document .bodywrapper .body div.figure p.caption { + text-align: center !important; +} + +.document .bodywrapper .body figure figcaption, +.document .bodywrapper .body div.figure p.caption { + padding-top: 0.1em !important; +} + +.document .bodywrapper .body figure figcaption p, +.document .bodywrapper .body div.figure p.caption { + margin-top: 0.1em !important; } .document .bodywrapper .body p strong, @@ -63,14 +83,32 @@ body { } .document .sphinxsidebar .sphinxsidebarwrapper h4 { - font-size: 18px !important; + color: #fff !important; + font-size: 16px !important; font-family: "Open Sans", sans-serif !important; + font-weight: 700 !important; + margin: 16px 0 2px !important; + text-transform: capitalize !important; +} + +.document .sphinxsidebar .sphinxsidebarwrapper h4::after { + content: ":" !important; } .document .sphinxsidebar .sphinxsidebarwrapper .topless a { + display: inline !important; font-size: 18px !important; font-family: "Open Sans", sans-serif !important; color: #fff !important; + line-height: 1.25 !important; + padding: 0 !important; + background-color: transparent !important; + text-decoration: none !important; + transition: color 0.15s ease !important; +} + +.document .sphinxsidebar .sphinxsidebarwrapper .topless a:hover { + color: #ff8200 !important; } .document .sphinxsidebar .sphinxsidebarwrapper p { @@ -102,7 +140,7 @@ body { font-size: 36px !important; font-family: "Open Sans", sans-serif !important; font-weight: 600 !important; - margin: 0 !important; + margin: 1.5em 0 0.5em !important; padding: 0 !important; border-bottom: none !important; background-color: #111827 !important; @@ -113,7 +151,7 @@ body { font-size: 30px !important; font-family: "Open Sans", sans-serif !important; font-weight: 600 !important; - margin: 0 !important; + margin: 1.25em 0 0.45em !important; padding: 0 !important; background-color: #111827 !important; color: #fff !important; @@ -124,13 +162,21 @@ body { font-size: 26px !important; font-family: "Open Sans", sans-serif !important; font-weight: 600 !important; - margin: 0 !important; + margin: 1em 0 0.4em !important; padding: 0 !important; background-color: #ff8200 !important; border-bottom: none !important; color: #fff !important; } +.document .bodywrapper section>h2+section>h3 { + margin-top: 0.2em !important; +} + +.document .bodywrapper section>h3+section>h4 { + margin-top: 0.2em !important; +} + .document .bodywrapper .highlight { background: #153659 !important; } @@ -177,14 +223,17 @@ body { } .related ul li.right a { + display: inline-block; text-transform: capitalize; padding: 10px 15px; background-color: #ff8200; border-radius: 5px; + transition: background-color 0.15s ease, transform 0.15s ease; } .related ul li.right a:hover { - padding: 11px 17px; + background-color: #ff9a26; + transform: scale(1.05); text-decoration: none; } @@ -202,6 +251,36 @@ dl.field-list>dt { background-color: #1c354f !important; } +.document .bodywrapper table.docutils th p, +.document .bodywrapper table.docutils td p { + text-align: left !important; +} + +.document .bodywrapper .footnote:target { + background-color: transparent !important; +} + +.document .bodywrapper .footnote-reference, +.document .bodywrapper .footnote .label, +.document .bodywrapper .footnote .label a, +.document .bodywrapper .footnote .fn-bracket { + color: #ff8200 !important; +} + +.document .bodywrapper .footnote, +.document .bodywrapper .footnote p { + line-height: 1.2 !important; +} + +.document .bodywrapper .footnote { + margin: 0.2em 0 !important; +} + +.document .bodywrapper .footnote p { + margin-top: 0 !important; + margin-bottom: 0 !important; +} + .document .bodywrapper .note { background-color: #1c354f !important; } @@ -254,8 +333,11 @@ dl.field-list>dt { font-size: 17px !important; } - .document .bodywrapper .body p span.caption-text { - font-size: 22px !important; + .document .bodywrapper .body p.caption, + .document .bodywrapper .body caption, + .document .bodywrapper .body span.caption-number, + .document .bodywrapper .body span.caption-text { + font-size: 14px !important; } .document .bodywrapper .body .toctree-wrapper.compound ul li.toctree-l1 a { diff --git a/docs/source/conf.py b/docs/source/conf.py index a564366..a70ee21 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -19,6 +19,12 @@ exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] numfig = True +numfig_format = { + 'figure': 'Fig. %s:', + 'table': 'Table %s:', + 'code-block': 'Listing %s', + 'section': 'Section %s', +} jinja2_contexts = { 'target-info': { diff --git a/docs/source/firmware.rst b/docs/source/firmware.rst index a952fb4..9ddd44f 100644 --- a/docs/source/firmware.rst +++ b/docs/source/firmware.rst @@ -39,16 +39,11 @@ versa, leaving the other as the rollback system. - 128 MB - Logging file system B (/var/log) -.. image:: ../../includes/_static/images/mountpoints.svg +.. figure:: ../../includes/_static/images/mountpoints.svg :alt: Filesystem-Mountpoints :align: center -.. adding a center-aligned caption for the image -.. raw:: html - -
- Filesystem Mountpoints -
+ Filesystem Mountpoints .. _update_from_chargebyte_to_everest: diff --git a/docs/source/getting_started.rst b/docs/source/getting_started.rst index 3cdf00f..91c369b 100644 --- a/docs/source/getting_started.rst +++ b/docs/source/getting_started.rst @@ -76,33 +76,29 @@ Now you can plug in the Charge Control C to the power supply. The LED status ind Charge Control C provide information about the current status of the boot process. The following table shows the meaning of the LED status indicators: -.. raw:: html - -
- Table: Charge Control C LED Status Indicators -
- -+--------------------------+---------------------------------+------------------------------------+ -| State | LED indication | Behavior | -+==========================+=================================+====================================+ -| Bootloader active | LED1 (green) | off | -| +---------------------------------+------------------------------------+ -| | LED2 (yellow) | off | -| +---------------------------------+------------------------------------+ -| | LED3 (red) | permanently on for approx. 3 sec. | -+--------------------------+---------------------------------+------------------------------------+ -| Boot process running | LED1 (green) | blinking for approx. 15 sec. | -| +---------------------------------+------------------------------------+ -| | LED2 (yellow) | off | -| +---------------------------------+------------------------------------+ -| | LED3 (red) | blinking | -+--------------------------+---------------------------------+------------------------------------+ -| Operating system running | LED1 (green) | permanently on | -| +---------------------------------+------------------------------------+ -| | LED2 (yellow) | off | -| +---------------------------------+------------------------------------+ -| | LED3 (red) | blinking | -+--------------------------+---------------------------------+------------------------------------+ +.. table:: Charge Control C LED Status Indicators + + +--------------------------+---------------------------------+------------------------------------+ + | State | LED indication | Behavior | + +==========================+=================================+====================================+ + | Bootloader active | LED1 (green) | off | + | +---------------------------------+------------------------------------+ + | | LED2 (yellow) | off | + | +---------------------------------+------------------------------------+ + | | LED3 (red) | permanently on for approx. 3 sec. | + +--------------------------+---------------------------------+------------------------------------+ + | Boot process running | LED1 (green) | blinking for approx. 15 sec. | + | +---------------------------------+------------------------------------+ + | | LED2 (yellow) | off | + | +---------------------------------+------------------------------------+ + | | LED3 (red) | blinking | + +--------------------------+---------------------------------+------------------------------------+ + | Operating system running | LED1 (green) | permanently on | + | +---------------------------------+------------------------------------+ + | | LED2 (yellow) | off | + | +---------------------------------+------------------------------------+ + | | LED3 (red) | blinking | + +--------------------------+---------------------------------+------------------------------------+ .. include:: ../../includes/connecting.inc diff --git a/docs/source/introduction.rst b/docs/source/introduction.rst index 93ad765..ba37918 100644 --- a/docs/source/introduction.rst +++ b/docs/source/introduction.rst @@ -92,21 +92,17 @@ Order Information Here are the currently available order codes for Charge Control C with EVerest: -.. raw:: html - -
- Table: Currently available order codes for Charge Control C with EVerest -
- -+----------------------+----------------------------------+------------+----------------------+ -| Available Order Code | SW Variant | Housing | HW Variant | -+======================+==================================+============+======================+ -| I2CCSC-E00-204 | chargebyte software stack v0.8.0 | no housing | Charge Control 200 | -| | based on EVerest 2024.3.0 | | (1x EIA-485, no CAN) | -+----------------------+----------------------------------+------------+----------------------+ -| I2CCSC-E00-303 | chargebyte software stack v0.8.0 | no housing | Charge Control 300 | -| | based on EVerest 2024.3.0 | | (2x EIA-485, no CAN) | -+----------------------+----------------------------------+------------+----------------------+ +.. table:: Currently available order codes for Charge Control C with EVerest + + +----------------------+----------------------------------+------------+----------------------+ + | Available Order Code | SW Variant | Housing | HW Variant | + +======================+==================================+============+======================+ + | I2CCSC-E00-204 | chargebyte software stack v0.8.0 | no housing | Charge Control 200 | + | | based on EVerest 2024.3.0 | | (1x EIA-485, no CAN) | + +----------------------+----------------------------------+------------+----------------------+ + | I2CCSC-E00-303 | chargebyte software stack v0.8.0 | no housing | Charge Control 300 | + | | based on EVerest 2024.3.0 | | (2x EIA-485, no CAN) | + +----------------------+----------------------------------+------------+----------------------+ The following figure shows the structure of the "I2CCSC-E00-204" order code: