About This Site

Built in IntelliJ (JetBrains IDE):

• python 3.6.6
  • using virtualenv (see Installing packages using pip and virtualenv
• gradle:
  • this uses the gradle plugin sphinx-gradle-plugin ( id "kr.motd.sphinx" version "2.3.1") https://github.com/trustin/sphinx-gradle-plugin Unfortunately, this plugin hard-codes the sphinx binary to use https://github.com/trustin/sphinx-binary . So the sphinx version is pinned to whatever that version is.
• Sphinx 1.8.1

  • sphinx-rtd-theme

    I’ve modified the theme for this site.

  • sphinxcontrib-plantuml

    This super helpful Sphinx plugin takes all of the .puml files and calls PlantUML to generate the .png files for the HTML pages.

  • javasphinx

I’ve written some Java code to extract information directly from PlantUML code. The extracted info is then used as input to my sphinx files. (I have a gradle java project that does all of that.) I also have some python code that creates some of the .puml files and initial rST code.

• Python plugin

to generate sphinx documentation locally:

• run task ‘sphinx’ (runs the gradle task from the sphinx-gradle-plugin)

Examples and inspiration:

• nicely done : shows small images of how each thing will look when formatted: https://ogom.github.io/draw_uml/plantuml/

Todo

Fix genindex columns: doesn’t deal with 2nd level entries when computing column splits see def write_genindex(self): in /Users/ashleyengelund/.pyenv/versions/3.6.6/lib/python3.6/site-packages/sphinx/builders/html.py

To Dos