Repository navigation
Conversation
|
@cameel cc |
|
Also CC @clonker. This would be the place for our implementation docs. |
| They are not part of the main table of contents. | ||
|
|
||
| .. toctree:: | ||
| :maxdepth: 2 |
There was a problem hiding this comment.
Let's reduce the depth here. The way it is now, the headings from inside the pages show up on the list. That would be fine for the sidebar where they fold, but will be too noisy when we add more pages here.
| @@ -1,7 +1,3 @@ | |||
| :orphan: | |||
|
|
|||
| .. index:: ! ethdebug, ! debug info | |||
There was a problem hiding this comment.
Continuing from #16990 (comment):
I think that having index entries would be fine, it's just that they should not be the first thing the user finds. For example here it could be something like ethdebug;implementation. Or generally something more specific than just ethdebug or debug info.
There was a problem hiding this comment.
Hmm, makes sense. I added ethdebug; internal debug info as a plain subentry, not a main one, so it doesn’t come up first.
…ntents Add a separate table of contents for pages aimed at compiler developers, which the main one does not link, and move the specification of the ethdebug internal debug info there under the implementation plans. Sphinx has one index for the whole documentation, so the page is indexed under a specific subentry, ethdebug; internal debug info, rather than as a main entry for ethdebug and debug info.
f676e62 to
61c31d7
Compare
2 participants
Adds
docs/compiler-guide/for pages aimed at compiler developers, with its own table of contents titled "Solidity Compiler Development Guide". The main table of contents does not link it.ethdebug_internal_debug_info.rstmoves there fromdocs/internals/under a new "Implementation plans" category. Its index entries are removed: Sphinx builds a single index for the whole documentation, so they would show up next to the user-facing pages.Split out of #16990 as suggested in the review. That PR adds a second category, "Feature guides", with the ethdebug implementation page.