VirtualTam's bookmarks

1. An introduction to Sphinx and Read the Docs for Technical Writers — Eric Holscher 2021-02-07

   tags: documentation, documentation/sphinx, programming/python

   [ permalink ]
2. doxyrest: A compiler from Doxygen XML to reStructuredText 2019-12-03

   tags: code, documentation, documentation/sphinx, programming/c, programming/c++, programming/html, programming/xml

   [ permalink ]
3. Markdown — Sphinx documentation 2018-10-21

   tags: documentation, documentation/sphinx, programming/markdown, read-the-docs, web

   [ permalink ]

   • https://blog.readthedocs.com/adding-markdown-support/
   • https://stackoverflow.com/questions/2471804/using-sphinx-with-markdown-instead-of-rst
   • https://github.com/rtfd/recommonmark
   • https://stackoverflow.com/questions/2471804/using-sphinx-with-markdown-instead-of-rst
4. Bernardo-MG/sphinx-docs-theme: A minimalist Bootstrap-based HTML5 theme for Sphinx 2018-03-26

   tags: documentation, documentation/sphinx, programming/html, programming/python

   [ permalink ]

   • https://developer.twitter.com/en/docs/tweets/optimize-with-cards/overview/abouts-cards
   • http://ogp.me/
5. Sphinx, apidoc and Django 2018-01-28

   tags: documentation, documentation/sphinx, framework/django, programming/api, programming/html, programming/python

   [ permalink ]

   • https://stackoverflow.com/questions/34461088/sphinx-apidoc-on-django-build-html-failure-on-django-core-exceptions-appregistr
   • https://stackoverflow.com/questions/19037649/using-sphinxs-sphinx-apidoc-utility-to-autogenerate-documentation-from-python-c
   • https://stackoverflow.com/questions/46375983/sphinx-apidoc-strange-output-for-django-app-models-py
   • http://www.sphinx-doc.org/en/stable/man/sphinx-apidoc.html
   • https://github.com/sphinx-doc/sphinx/issues/2095
   • https://samnicholls.net/2016/06/15/how-to-sphinx-readthedocs/
   • http://www.sphinx-doc.org/en/stable/ext/napoleon.html
6. Mscgen: A Message Sequence Chart Renderer 2017-09-19

   tags: diagram, documentation/sphinx, doxygen, software-engineering/uml

   [ permalink ]
7. sphinx-js 2.0.1 : Python Package Index 2017-08-20

   tags: documentation, documentation/sphinx, programming/javascript, read-the-docs

   [ permalink ]

   • https://github.com/erikrose/sphinx-js
   • https://hacks.mozilla.org/2017/07/introducing-sphinx-js-a-better-way-to-document-large-javascript-projects/
   • https://news.ycombinator.com/item?id=14786554
8. The Linux Kernel documentation — The Linux Kernel documentation 2017-08-20

   tags: documentation, documentation/sphinx, linux, linux/kernel, programming/python, read-the-docs, rtfm

   [ permalink ]

   • https://www.youtube.com/watch?v=jY_C-Z0qMSo
9. rinohtype: The Python Document Processor 2017-06-20

   tags: documentation, documentation/sphinx, pdf, programming/python, tex

   [ permalink ]

   • https://github.com/brechtm/rinohtype
   • https://pypi.python.org/pypi/RinohType/
   • http://www.sphinx-doc.org/en/stable/builders.html#sphinx.builders.latex.LaTeXBuilder
10. recommonmark — A docutils-compatibility bridge to CommonMark 2017-01-23

    tags: documentation, documentation/sphinx, markup, programming/markdown, programming/python

    [ permalink ]

    • http://commonmark.org/
    • https://github.com/rtfd/recommonmark
    • used by https://github.com/mattermost/docs
11. Breathe’s documentation - Doxygen to Sphinx bridge 2015-09-17

    tags: development, documentation, documentation/sphinx, doxygen, generation

    [ permalink ]

    https://github.com/michaeljones/breathe

12. Developer to Documentarian - Lounge Scene 2015-08-09

    tags: development, documentation, documentation/sphinx, open, source

    [ permalink ]
13. Releases | A better changelog 2015-08-09

    tags: changelog, documentation, documentation/sphinx, note, observability/logging, programming/python, release, web

    [ permalink ]

    via http://bitprophet.org/blog/2013/09/14/a-better-changelog/ see http://www.fabfile.org/changelog.html