The Wayback Machine - https://web.archive.org/web/20201117161451/https://github.com/topics/documentation-generator
Skip to content
#

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 447 public repositories matching this topic...

wowchemy-hugo-modules
tvercaut
tvercaut commented Nov 9, 2020

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_interests one would be goo

webjunkie
webjunkie commented Aug 24, 2018

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

NiklasRosenstein
NiklasRosenstein commented Jun 14, 2020

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

Wikipedia
Wikipedia
You can’t perform that action at this time.