4 ms·
What is deep linking into a different document? You mean to a header or something else?
by mosselman 3y ago
What is deep linking into a different document? You mean to a header or something else?
- bluGill 3y agoFrom one document to the middle of a different one. I use restructured text which lets me link that way. It is a little tricky, but not difficult and makes it much easier to have documents reference others. I have separate user documentation from design documentation, but the design documentation often needs to reference the user documentation for the thing it just talked about to get into details that otherwise would have to be repeated. Unfortunately restructure text is not nearly as popular as markdown and so lots of other tools I want either don't exist, or are out of date.
- formerly_proven 3y agoThe lack of non-docutils implementations is easily explained by rst being essentially impossible to parse; it's also somewhat annoying to write, in particular with the distinct lack of nested markup and the very baroque indentation rules - try writing nested lists without accidentally putting half of them in blockquotes. That being said sphinx-doc works very well even for complex projects and most documentation tools are rather inferior, much like static site generators it's a straightforward project to get to a "works for me" point. rst (and sphinx) are also one of the few (open source) options which have some support for multiple modalities.