-
Updated
Apr 30, 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 508 public repositories matching this topic...
-
Updated
Apr 21, 2021 - 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
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
May 5, 2021 - TypeScript
-
Updated
Mar 25, 2021 - JavaScript
-
Updated
Apr 30, 2021 - Python
-
Updated
Apr 16, 2021 - Go
-
Updated
May 1, 2021 - Go
-
Updated
May 5, 2021 - JavaScript
With Python 3.5.x having reached its end of life/support, we can begin to use "advanced" features from Python 3.6:
-
Updated
May 1, 2021 - PHP
Hi! Longtime listener, first caller. Which is to say, I'm a big fan of fastai -- so, thank you all very much. :)
On the latest pip-installed version of fastai (fastai==2.2.5, fastcore==1.3.19), when I try to load an empty pandas DataFrame into a DataLoader using from_df
, it gets stuck in an infinite loop.
Works as expected:
!pip install -U -q fastai
from fastai.text.all import *
-
Updated
May 2, 2021 - Python
-
Updated
May 4, 2021 - Julia
-
Updated
Jul 31, 2020 - Go
-
Updated
May 5, 2021 - JavaScript
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
Apr 22, 2021 - 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
May 3, 2021 - JavaScript
-
Updated
Jan 7, 2021 - C++
-
Updated
Mar 16, 2021 - Python
-
Updated
Mar 31, 2021 - Python
-
Updated
Apr 9, 2021 - TypeScript
-
Updated
Mar 10, 2021 - F#
-
Updated
Apr 10, 2019 - CoffeeScript
- Wikipedia
- Wikipedia
Publications in Wowchemy currently use Article JSON-LD rather than the more specific ScholarlyArticle structured data as ScholarlyArticle is not eligible for rich Google search results whereas Article is.
However, use