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

nbdev
jvivian
jvivian commented Mar 1, 2022

Version: 1.2.2

Summary of issue
Including a @dataclass decorated class breaks getsource in show_doc

Minimal example

  • Clone nbdev_tutorial
  • Add new cell in 00_core.ipynb
#export
from dataclasses import dataclass

@dataclass
class Foo:
    a: int
    b: str
    c: float
  • Run nbdev_build_lib
  • Run nbdev_build_docs
nbdev_build_docs
bug good first issue
jorisvanzundert
jorisvanzundert commented May 8, 2019

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

enhancement good first issue
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

pdoc
spectaql
iSarCasm
iSarCasm commented Apr 26, 2022

Right now, we want to add a lot more information to the description. This is especially true for some of our Mutations which have complex validation logic. it would be great to have a way to either overwrite or append/prepend descriptions to specific items. Ideally, using markdown .md would be also great which makes it easier to store descriptions in separate files and add some formatting.

enhancement good first issue awaiting-more-info
log4brains
thomvaill
thomvaill commented Apr 30, 2021

Feature Request

Feature Suggestion

This is working:

- Status: superseded by [20201016-use-the-adr-slug-as-its-unique-id](20201016-use-the-adr-slug-as-its-unique-id.md)

This is not working:

- Status: superseded by [custom name](20201016-use-the-adr-slug-as-its-unique-id.md)

-> Let's make it work!

Context

Today, the link name MUST b

feature good first issue
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