-
Updated
Sep 1, 2021 - 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 535 public repositories matching this topic...
-
Updated
Aug 21, 2021 - Jupyter Notebook
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
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.
-
Updated
Aug 11, 2021 - TypeScript
-
Updated
Aug 31, 2021 - JavaScript
-
Updated
Jun 1, 2021 - Go
-
Updated
Aug 23, 2021 - Python
-
Updated
Sep 3, 2021 - JavaScript
-
Updated
Aug 27, 2021 - Go
With Python 3.5.x having reached its end of life/support, we can begin to use "advanced" features from Python 3.6:
-
Updated
Sep 7, 2021 - Python
-
Updated
Aug 28, 2021 - PHP
-
Updated
Sep 2, 2021 - Jupyter Notebook
-
Updated
Sep 7, 2021 - Julia
-
Updated
Aug 24, 2021 - JavaScript
-
Updated
Sep 6, 2021 - JavaScript
-
Updated
May 14, 2021 - Go
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
Sep 1, 2021 - Julia
-
Updated
May 9, 2021 - JavaScript
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
Sep 6, 2021 - Python
-
Updated
Jul 16, 2021 - C++
-
Updated
Mar 31, 2021 - Python
-
Updated
Apr 9, 2021 - TypeScript
-
Updated
Sep 1, 2021 - F#
-
Updated
Aug 25, 2021 - Python
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
- Wikipedia
- Wikipedia
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 theto_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