Code not rendering #9
Comments
|
Logs FYI |
ColinKennedy
added a commit
that referenced
this issue
Mar 13, 2024
Added GitHub workflow action + add Python 3.10 support
|
I've made a PR to add proper CI for Python 2.7, 3.6+<3.11 for Ubuntu, Windows, and MacOS just to be sure things still work as expected. That said, the latest update probably isn't going to immediately fix your issue. But you might want to try the newly released version If not, I'm thinking
.. code-include :: :func:`foo.bar`
:fallback-text: <foo.bar NOT FOUND>To aid in troubleshooting. With some fallback text we can confirm if sphinx-code-include is actually loading and it's just the |
This was referenced Mar 15, 2024
ColinKennedy
added a commit
that referenced
this issue
Mar 16, 2024
Added better documentation about troubleshooting broken links
|
I added documentation on troubleshooting. There's 3 ways to get logs, errors, etc depending on what you need now. You can read about it here: https://sphinx-code-include.readthedocs.io/en/stable/troubleshooting.html I'll copy and paste the text below too, just in case that link goes down ===============
Troubleshooting
===============
The code-include is not showing up. What do I do?
=================================================
Add Fallback Text
+++++++++++++++++
If you add ``:fallback-text:`` to your ``code-include`` directive, even if your
target is missing, ``code-include`` will still always show something.
::
.. code-include :: :func:`foo`
Enable Logging
++++++++++++++
Instead of building your sphinx documentation with a command like
.. code-block:: sh
sphinx-build documentation/source documentation/build
Try using
.. code-block:: sh
LOG_LEVEL=0 sphinx-build documentation/source documentation/build
``code-include`` comes with logging messages and ``$LOG_LEVEL`` controls the verbosity.
0 = all+ (show everything)
10 = debug+ (very verbose)
20 = info+ (useful messages)
30 = warning+ (a message indicating a cause for concern)
40 = errors+ (something broke in an unrecoverable way)
Enable Exceptions
+++++++++++++++++
``code-include`` by default doesn't prevent docs from building if an exception is found.
You can disable this (e.g. raise exceptions) by adding this to your ``conf.py``:
.. code-block:: python
code_include_reraise = True@vict0rsch Please let me know if this works for you |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Hey,
I don't see any rendering of the directives, and no error from the build. How can I debug? Thanks!
The text was updated successfully, but these errors were encountered: