Documentation is a set of information that describes a product to its users, including what it is, how it operates, and how to use it.
I'm using https://github.com/Artory/drf-hal-json/ that basically provides custom base serializers that add dynamically fields like _links into the response via the to_representation method.
I tried to somehow get that into the schema as well, but I'm getting stuck. Are there any directions on what I need to provide/subclass/overwrite, so to make it work?
I imagine I could inspect my seri
If a public type is named Home, _Sidebar, or _Footer, its generated documentation would be overwritten by the special page of the same name. We should add logic in the generate subcommand to handle this possibility.
With Python 3.5.x having reached its end of life/support, we can begin to use "advanced" features from Python 3.6:
Each parameter gets included twice in the rendered output
/// Begins the flow
/// - Parameter navigationController: presentation context
func beginFlow(in n
You can have two API objects that use the same anchor reference. When both are rendered into the same Markdown file, the references are not unique, and one of the links will not work.
def a():
""" Links to [a][0].
[0]: https://a.org """
def b():
""" Links to [b][0].
[0]: https://b.org """The MarkdownRenderer should find such duplicate references (here 0 an
This is working:
- Status: superseded by [20201016-use-the-adr-slug-as-its-unique-id](20201016-use-the-adr-slug-as-its-unique-id.md)This is not working:
- Status: superseded by [custom name](20201016-use-the-adr-slug-as-its-unique-id.md)-> Let's make it work!
Today, the link name MUST b
Hi,
(Apologies for being a bit verbose.)
Is it possible to have section headers in the sidebar that are links to section anchors? Thus, section headers that point to e.g. "/mybook/chapter_002#a-particular-section. (Each # header in .md becomes an anchor.)
I tried a workaround by using simply
external: true, but this fails because_prepare_toc()errors out on the hashtag. Besid