search

RadiantLabs / modeling-api-docs

Official Modeling API documentation
0 stars 1 forks source link

Apply fixes to solve Sphinx warnings #9

Closed joshuamzm closed 1 year ago

joshuamzm commented 1 year ago

Problems reported by Sphinx:


Text in column margin in table line 5.

=================================  =======  ================  ==============  ========  ==================  ==============================================
Property                           Type     Units             Constraints     Required  Default             Notes
=================================  =======  ================  ==============  ========  ==================  ==============================================
``id``                             id                         Must be unique  yes       Attic1
``area``                           float   ft2                >0              no        PSC
``isVented``                       boolean                                    no        yes
``floorAssemblyEffectiveRValue``   float   F-ft2-hr/Btu       >0              no        BSA
=================================  =======  ================  ==============  ========  ==================  ==============================================
/home/docs/checkouts/readthedocs.org/user_builds/radiant-labs-modeling-api-documentation/checkouts/latest/docs/source/api.rst:408: WARNING: Title underline too short.

HVAC Air Distribution Systems
~~~~~~~~~~~~~~~~~~~~~~~~~
/home/docs/checkouts/readthedocs.org/user_builds/radiant-labs-modeling-api-documentation/checkouts/latest/docs/source/api.rst:408: WARNING: Title underline too short.

HVAC Air Distribution Systems
~~~~~~~~~~~~~~~~~~~~~~~~~
/home/docs/checkouts/readthedocs.org/user_builds/radiant-labs-modeling-api-documentation/checkouts/latest/docs/source/automated_measures.rst:85: ERROR: Content block expected for the "note" directive; none found.
/home/docs/checkouts/readthedocs.org/user_builds/radiant-labs-modeling-api-documentation/checkouts/latest/docs/source/automated_measures.rst:335: ERROR: Too many autonumbered footnote references: only 22 corresponding footnotes available.
/home/docs/checkouts/readthedocs.org/user_builds/radiant-labs-modeling-api-documentation/checkouts/latest/docs/source/automated_measures.rst:4: WARNING: duplicate label automated_measures, other instance in /home/docs/checkouts/readthedocs.org/user_builds/radiant-labs-modeling-api-documentation/checkouts/latest/docs/source/api.rst```
joshuamzm commented 1 year ago

There are no more warnings with the changes from the last commit.