-
Updated
Aug 27, 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 419 public repositories matching this topic...
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, 2020 - Jupyter Notebook
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
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
May 31, 2020 - JavaScript
-
Updated
Aug 28, 2020 - TypeScript
-
Updated
Aug 28, 2020 - Go
-
Updated
Aug 23, 2020 - JavaScript
-
Updated
Aug 15, 2020 - PHP
Expected Behavior
A global variable not included in __all__
but whitelisted in __pdoc__
is included in the documentation.
Actual Behavior
It is not.
Steps to Reproduce
- See the following minimal example (and save it as
example.py
;)). - Generate the
-
Updated
Aug 25, 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
Jun 16, 2020 - C++
-
Updated
Aug 21, 2020 - Julia
-
Updated
Jul 31, 2020 - Python
-
Updated
Aug 26, 2020 - Python
-
Updated
Dec 11, 2019 - Python
-
Updated
Apr 10, 2019 - CoffeeScript
-
Updated
Aug 25, 2020 - JavaScript
-
Updated
Aug 22, 2020 - TypeScript
-
Updated
Jul 19, 2020 - F#
-
Updated
Sep 12, 2018 - Python
-
Updated
Jul 13, 2020 - Python
-
Updated
Aug 27, 2020 - TypeScript
-
Updated
Mar 22, 2020 - JavaScript
-
Updated
Jul 11, 2020 - Haxe
- Wikipedia
- Wikipedia
Feature Request
Is your feature request related to a problem? Please describe.
Not really a problem but SVG favicons are the future (present).
Describe the solution you'd like
Support for SVG favicons, as it is already supported in the case of the
logo
image.Describe alternatives you've considered
None.
Additional context
[This](https://css-tricks.com/svg-favi