Giter VIP home page Giter VIP logo

sphinx-lectern's People

Contributors

atrnh avatar

Stargazers

 avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar

sphinx-lectern's Issues

Add additional types of admonitions

Summary

We only have these pretty lame admonitions:

  • Default
  • Note
  • Warning
  • Hint

It'd be nice to have more. Like Sophia:

  • Terms to know
  • Big idea
  • Did you know?
  • Step-by-step

Details

We should also remove Note. Because it's so generic and useless. The final lineup:

  • Terms to know
  • Big idea
  • Did you know?
  • Step-by-step
  • Warning
  • Hint

Tests. Tests for literally everything

Summary

We need tests.

Notes

I’m not a fan of unit tests. I think integration tests are way more useful. I’ve got some basic, rudimentary scaffolding for integration tests with pytest. I imagine it’d go something like this:

  1. Build HTML doc
  2. Parse with Beautiful Soup
  3. Test against Beautiful Soup nodes

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.