Code Monkey home page Code Monkey logo

Comments (3)

mgaitan avatar mgaitan commented on June 10, 2024 1

I guess this should work https://github.com/sphinx-extensions2/sphinx-autodoc2 , could you try it ? the docstring there could be any source renderable by sphinx. .

so, for instance using myst your code will looks like this

def foo() -> None:
    """
    Some Google-style docstring.

    ```mermaid
        flowchart TD
            A["Foo"]
     ```       
    """

the conf.py

extensions = [
    "myst_parser",
    "sphinxcontrib.mermaid",
    "autodoc2",
    ...
]

autodoc2_packages = [
    {
        "path": "path/to/your/code",
        "auto_mode": False,
    },
]
autodoc2_render_plugin = "myst"

and the doc page where you want to include the ref

# page title

```{autodoc2-object} path.to.your.code.foo
```

from sphinxcontrib-mermaid.

mgaitan avatar mgaitan commented on June 10, 2024 1

cool!

from sphinxcontrib-mermaid.

jamesbraza avatar jamesbraza commented on June 10, 2024

Actually, this worked 😄:

def foo() -> None:
    """
    Some Google-style docstring.

    .. mermaid::
       flowchart TD
           A["Foo"]
    """

Turns out, this is already fully supported (uses Sphinx automodule)! Feel free to close this out...

from sphinxcontrib-mermaid.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.