-
Updated
Jul 6, 2022 - TypeScript
documentation-generator
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.
Here are 600 public repositories matching this topic...
-
Updated
Jun 27, 2022 - Jupyter Notebook
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
-
Updated
Aug 27, 2021 - Swift
-
Updated
Jun 4, 2022 - TypeScript
-
Updated
Feb 26, 2022 - JavaScript
-
Updated
Jun 28, 2022 - Python
-
Updated
Oct 25, 2021 - Go
-
Updated
Jul 3, 2022 - Python
-
Updated
Jul 6, 2022 - JavaScript
-
Updated
Jun 2, 2022 - Go
-
Updated
Jul 2, 2022 - Jupyter Notebook
-
Updated
Jun 26, 2022 - PHP
Right now, we want to add a lot more information to the description. This is especially true for some of our Mutations which have complex validation logic. it would be great to have a way to either overwrite or append/prepend descriptions to specific items. Ideally, using markdown .md
would be also great which makes it easier to store descriptions in separate files and add some formatting.
-
Updated
Jul 6, 2022 - Julia
-
Updated
Jun 28, 2022 - Go
-
Updated
Jun 14, 2022 - JavaScript
Feature Request
Feature Suggestion
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!
Context
Today, the link name MUST b
-
Updated
Jun 3, 2022 - Julia
-
Updated
Jun 22, 2022 - JavaScript
-
Updated
May 8, 2022 - Rust
Brief Description
Each parameter gets included twice in the rendered output
Steps to Reproduce
- Find a method with parameters, and use Xcode's "Add documentation" shortcut to create a doc template:
/// Begins the flow
/// - Parameter navigationController: presentation context
func beginFlow(in n
-
Updated
Apr 25, 2022 - Go
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
-
Updated
Jul 1, 2022 - Python
-
Updated
May 9, 2021 - JavaScript
-
Updated
Mar 24, 2022 - C++
-
Updated
Apr 4, 2022 - Python
- Wikipedia
- Wikipedia
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