Hi,
I am just learning Sphinx and would appreciate guidance on the best way to
insert links to external records. Specifically wanting to write product
documentation in Sphinx and link to corresponding API documentation, as
well as related specification/requirement records. I'm imagining something
along the lines of:
Example feature
--------------------------
This feature does xyz. You can use it by doing abc.
.. api :: example-feature, list-example-features
.. req :: R-123, R-456
Both directives would insert a block that look similar to the "seealso"
directive, something like:
API Reference
example-feature, list-example-features
Requirements
R-123, R-456
Hyperlinked to the external reference, which has a fixed format derived
from the name, e.g.
example-feature would link to https://api.example.com/example-feature
R-123 would link to https://issue-tracker.example.com/R-123
I followed the HelloWorld custom directive tutorial, but am not sure where
to go from there, or if that's even the best starting point. In any case, I
thought I should ask for help from the experts for any advice you may have,
which would be very much appreciated!
Thank you,
Ed
--
You received this message because you are subscribed to the Google Groups
"sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email
to [email protected].
To view this discussion on the web visit
https://groups.google.com/d/msgid/sphinx-users/0937ae58-3f2e-4e6d-9787-f79f893d44c2n%40googlegroups.com.
