Jonkman Microblog
  • Login
Show Navigation
  • Public

    • Public
    • Network
    • Groups
    • Popular
    • People

Conversation

Notices

  1. Alex (avolkov@mastodon.xyz)'s status on Wednesday, 19-Sep-2018 12:14:16 EDT Alex Alex

    @Gargron @staticsafe Read the docs is mostly rst with some custom tags. That thing that's good about rst that it's formally defined, unlike having every imaginable markdown flavor under the sun, but the learning curve is a bit steep.

    This is a good intro -- https://thomas-cokelaer.info/tutorials/sphinx/rest_syntax.html

    I also like OmniMarkupPrviewer when editing rst docs -- https://github.com/timonwong/OmniMarkupPreviewer

    This is a very good tutorial, but it's almos 3hrs long :( -- https://www.youtube.com/watch?v=hM4I58TA72g

    In conversation Wednesday, 19-Sep-2018 12:14:16 EDT from mastodon.xyz permalink

    Attachments

    1. Invalid filename.
      Eric Holscher - Documenting your project with Sphinx & Read the Docs - PyCon 2016
      from YouTube
      Speaker: Eric Holscher This tutorial will cover how to write documentation using RST, Sphinx, and publish it on Read the Docs. It will walk users through the...
  • Help
  • About
  • FAQ
  • TOS
  • Privacy
  • Source
  • Version
  • Contact

Jonkman Microblog is a social network, courtesy of SOBAC Microcomputer Services. It runs on GNU social, version 1.2.0-beta5, available under the GNU Affero General Public License.

Creative Commons Attribution 3.0 All Jonkman Microblog content and data are available under the Creative Commons Attribution 3.0 license.

Switch to desktop site layout.