-
Updated
Nov 10, 2020 - TypeScript
{{ message }}
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.
Create delightful python projects using Jupyter Notebooks
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
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.
Generate markdown documentation from jsdoc-annotated javascript
Static page generator for documenting GraphQL Schema
RESTful API 文档生成工具,支持 Go、Java、Swift、JavaScript、Rust、PHP、Python、Typescript、Kotlin 和 Ruby 等大部分语言。
Generate GitBook style modern docs/tutorial websites using Gatsby + MDX
Daux.io is an documentation generator that uses a simple folder structure and Markdown files to create custom documentation on the fly. It helps you create great looking documentation in a developer friendly way.
With Python 3.5.x having reached its end of life/support, we can begin to use "advanced" features from Python 3.6:
Python supercharged for the fastai library
A documentation generator for Julia.
Generate documentation for your REST/HTTP API from your Go unit tests
I have the following setup:
Fn::ImportValueStack1:
custom:
documentation:
models:
- name: BadRequest400ResponseJSON
contentType: 'application/json'
schema: ....
Each parameter gets included twice in the rendered output
/// Begins the flow
/// - Parameter navigationController: presentation context
func beginFlow(in n
A compiler from Doxygen XML to reStructuredText -- hence, the name. It parses XML databases generated by Doxygen and produces reStructuredText for the Python documentation generator Sphinx.
Simple package for literate programming in 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
Tool to create minimalist and beautiful API documentation pages using your Insomnia workspace export file.
Automatically generates FORtran Documentation from comments within the code.
DART is a test documentation tool created by the Lockheed Martin Red Team to document and report on penetration tests, especially in isolated network environments.
Sane and flexible OpenAPI 3 schema generation for Django REST framework.
generate your static website in 3 seconds
Scriptable static site generator using type safe F# DSL to define page templates.
Tool to automate common OSINT tasks
Preprocessed Python functions and docstrings for automated code documentation (code2doc) and automated code generation (doc2code) tasks.
Feature Request
Is your feature request related to a problem? Please describe.
For academic projects, it is often the case that a consortium of organisations is involved. The people details allow to specify the organisation already but this information is not shown on the homepage widget.
Describe the solution you'd like
An option similar to the
show_interestsone would be goo