RTDs: Fail on warning

Fix outstanding sphinx warnings;
- Change mycells.lib to use `text` parsing instead of (currently) unsupported `Liberty`.
- Remove unused `troubleshooting.rst`, moving the todo into the index.
This commit is contained in:
Krystine Sherwin 2024-09-03 10:20:24 +12:00
parent ecff434886
commit 840c515ffc
No known key found for this signature in database
4 changed files with 6 additions and 7 deletions

View File

@ -13,6 +13,7 @@ formats:
sphinx: sphinx:
configuration: docs/source/conf.py configuration: docs/source/conf.py
fail_on_warning: true
python: python:
install: install:

View File

@ -3,6 +3,8 @@ More scripting
.. todo:: brief overview for the more scripting index .. todo:: brief overview for the more scripting index
.. todo:: troubleshooting document(?)
.. toctree:: .. toctree::
:maxdepth: 3 :maxdepth: 3

View File

@ -1,6 +0,0 @@
Troubleshooting
~~~~~~~~~~~~~~~
.. todo:: troubleshooting document(?)
See :doc:`/cmd/bugpoint`

View File

@ -90,8 +90,10 @@ Mapping to hardware
For this example, we are using a Liberty file to describe a cell library which For this example, we are using a Liberty file to describe a cell library which
our internal cell library will be mapped to: our internal cell library will be mapped to:
.. todo:: find a Liberty pygments style?
.. literalinclude:: /code_examples/intro/mycells.lib .. literalinclude:: /code_examples/intro/mycells.lib
:language: Liberty :language: text
:linenos: :linenos:
:name: mycells-lib :name: mycells-lib
:caption: :file:`mycells.lib` :caption: :file:`mycells.lib`