Documentation

DocGen4.DB.VersoDocString

Verso Docstring Serialization #

Verso docstrings (VersoDocString) contain a tree of Doc.Block/Doc.Inline nodes, which can include extension points (ElabInline/ElabBlock) which are opaque Dynamic values identified by Name. Different Lean packages can register their own extension types, so we can't know all possible types ahead of time.

The serialization strategy is:

builtinDocstringValues (defined at the bottom of this file) registers the handlers for extension types that ship with Lean. If a downstream package defines custom Verso extensions, it would need to provide its own DocstringValues with additional handlers. There's presently no API for this, but the code is designed to allow plugins that provide handlers in the future.

Serializer/deserializer pair for a single Verso extension type.

Instances For

    Registry of known Verso extension types, keyed by Name.

    Instances For
      Equations
      Instances For
        Equations
        Instances For
            Instances For
              @[implicit_reducible]
              Equations
              Equations
              Instances For
                Equations
                Instances For
                  @[implicit_reducible]
                  Equations
                  • One or more equations did not get rendered due to their size.
                  Instances For
                    @[implicit_reducible]
                    Equations
                    • One or more equations did not get rendered due to their size.
                    Instances For

                      Builtin Data.* handlers #

                      Equations
                      • One or more equations did not get rendered due to their size.
                      Instances For
                        Equations
                        • One or more equations did not get rendered due to their size.
                        Instances For
                          Equations
                          • One or more equations did not get rendered due to their size.
                          Instances For
                            Equations
                            • One or more equations did not get rendered due to their size.
                            Instances For
                              Equations
                              • One or more equations did not get rendered due to their size.
                              Instances For
                                Equations
                                • One or more equations did not get rendered due to their size.
                                Instances For