-
Updated
Dec 11, 2020 - 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 460 public repositories matching this topic...
In reading through several of the docs, it wasn't clear how to format #export
for the purposes of creating a different external file.
It might be nice to here (https://nbdev.fast.ai/export.html#notebook2script) or elsewhere to list some examples for how to add a parameter to #export
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
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
Sep 2, 2020 - JavaScript
-
Updated
Dec 11, 2020 - TypeScript
-
Updated
Oct 17, 2020 - Go
-
Updated
Dec 8, 2020 - JavaScript
-
Updated
Dec 12, 2020 - PHP
With Python 3.5.x having reached its end of life/support, we can begin to use "advanced" features from Python 3.6:
-
Updated
Dec 12, 2020 - Jupyter Notebook
-
Updated
Dec 10, 2020 - Julia
-
Updated
Jul 31, 2020 - Go
I have the following setup:
- multiple stacks with shared API Gateway (see serverless docs)
- stack 1 defines a specific model and exports it (see serverless docs)
- stack 2 should make us of the model via
Fn::ImportValue
Stack1:
custom:
documentation:
models:
- name: BadRequest400ResponseJSON
contentType: 'application/json'
schema: ....
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
Nov 17, 2020 - C++
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
Dec 6, 2020 - JavaScript
-
Updated
Nov 6, 2020 - Julia
-
Updated
Dec 8, 2020 - Python
-
Updated
Aug 26, 2020 - Python
-
Updated
Dec 11, 2019 - Python
-
Updated
Dec 7, 2020 - TypeScript
-
Updated
Apr 10, 2019 - CoffeeScript
-
Updated
Oct 23, 2020 - F#
-
Updated
Sep 12, 2018 - Python
-
Updated
Sep 15, 2020 - Jupyter Notebook
-
Updated
Jul 13, 2020 - Python
- Wikipedia
- Wikipedia
Feature Request
Add
data-srcset
for lazy loading multi-res mobile/desktop images.Initially apply to list items (views).
Docs: https://afarkas.github.io/lazysizes/index.html
May increase Lighthouse score.