Giter VIP home page Giter VIP logo

sphinx-mermaid's People

Contributors

doreapp avatar jaxbulsara avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar

sphinx-mermaid's Issues

Introduce usage of custom plugin

  • Add .. mermaid :: directive and make it work as intended
  • Add a usage example in the readme

๐Ÿ’ก No need to setup a sphinx-based documentation for now

[Bug] make.bat latex failed

It's not possible to generate image file when generate latex files

Is it possible to automatically generate equivalente image file when build the sphinx to latex?

Add an autogenerated documentation

  • Github actions generating the documentation
  • Github pages serving the documentation
  • A link in the readme to the documentation
  • A link in the documentation to the readme and the pypi package

Setup the python package

Setup the python package with

  • All of whats needed to deploy the package on pip
  • A documentation of the package purpose
  • CI/CD for python file check (black, isort, pylint)

Fix deployment to pypi

For an obscure reason, deployment of the package to pypi repo when a release is created fails.

Investigate and fix this behavior

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.