-
Updated
Oct 21, 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 439 public repositories matching this topic...
The example book created by jupyter-book create
creates files with permissions 775. None of these files are really executable, and therefore the correct permissions should be 664 (or probably 644)
To Reproduce
jupyter-book create test; ls -al test
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
Oct 20, 2020 - Jupyter Notebook
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
Oct 16, 2020 - TypeScript
-
Updated
Oct 17, 2020 - Go
-
Updated
Oct 6, 2020 - JavaScript
-
Updated
Sep 21, 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
Oct 20, 2020 - Jupyter Notebook
-
Updated
Oct 21, 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
Sep 25, 2020 - C++
-
Updated
Sep 27, 2020 - Julia
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
Aug 26, 2020 - Python
-
Updated
Oct 9, 2020 - JavaScript
-
Updated
Dec 11, 2019 - Python
-
Updated
Aug 22, 2020 - TypeScript
-
Updated
Apr 10, 2019 - CoffeeScript
-
Updated
Aug 30, 2020 - F#
-
Updated
Sep 12, 2018 - Python
-
Updated
Oct 20, 2020 - Python
-
Updated
Jul 13, 2020 - Python
-
Updated
Oct 7, 2020 - TypeScript
- Wikipedia
- Wikipedia
Feature Request
Are there any plans to support PWA?