Point the docs to new jinja macro files #8577
Conversation
yuumasato
added
bugfix
|
Start a new ephemeral environment with changes proposed in this pull request: |
|
the PR fixes the issue the doc build but I still see some references of the highlevel.jinja file for example: |
This helps us pointo to the toctree entries.
| @@ -395,6 +387,8 @@ specified, and they depend on each other. Macros that begin with | |||
| make sure that OCIL and OCIL clauses are defined and consistent. Macros | |||
| that begin with underscores are not meant to be used in descriptions. | |||
|
|
|||
| You can check documentation for all macros in the [Jinja Macros Reference section](../../index.html#jinja-macros-reference). | |||
There was a problem hiding this comment.
Unfortunately this type of reference doesn't work when the content is built by readthedocs and I was not able to find a workaround for that similar as the deleted line 388
There was a problem hiding this comment.
It seems a lot of references in https://complianceascode.readthedocs.io/en/latest/manual/developer/03_creating_content.html with the same syntax are broken.
There was a problem hiding this comment.
I have rewritten the paragraph to remove the broken reference link.
There was a problem hiding this comment.
It seems a lot of references in https://complianceascode.readthedocs.io/en/latest/manual/developer/03_creating_content.html with the same syntax are broken.
these come when we did the conversion from .adoc to .md and when we hosted in github. Those we can easily fix by changing to the actual file in the github project.
The references with local reference don't work on Read the Docs.
Description:
Rationale: