Skip to main content

Dialog Flow Framework Sphinx Theme is a sphinx theme for building DFF distributed website

Project description

Dialog Flow Framework Sphinx Theme

Dialog Flow Framework Sphinx Theme is a sphinx theme for building DFF distributed website

Install project with demo module: make DEMO_BASE_URL="[DEMO_MODULE_BASE_PATH]" demo-build NB! Requires NodeJS >= 8.4.0 and Python >= 3.7 (compatible with dff).

Analyzed and updated source files (.ts and .scss) are marked with following header:

/**
* Final redaction
**/

WARNING! SASS styling is still under way. By the time this inscription is being made, designing (mobile, middle-size) is still in process. After website is finished and all required elements added, we should revisit SASS files once again. We should:

  1. Restore everything that was useful and for any reason was deleted (regarding not-yet-included Sphinx addons and possibilities).
  2. Finish styling for website to match design.
  3. If needed, revisit TypeScript files too, some (most) of them were untouched since PyTorch import, only God knows if (and how) they work.
  4. Remove everything unused (RTD and PyTorch classes or Sphinx addons we don't need).
  5. Remove big files (_sphinx_base.scss), split them into smaller ones, specifying design for one particular element of website.

I'm sorry to release the theme in this condition. However, I don't have enough time to fix it and most importantly I don't know what website will look like yet, so it's impossible to check if most of the elements work, how they work and if they are needed at all. Dear future programmer of DFF Sphinx theme, please accept my apologies and be strong.

Global TODO:

  • Add format rules to Makefile
  • Add testing
  • Add docs (maybe insert demo module into docs)

Local TODO:

  • Replace .ts string concatenation with `-wrapped strings
  • Add pencil icon (if needed) _static/pencil-16.png
  • Fix button from sphinx_copybutton plugin
  • Finish color replacement with variables in .scss files + clean variables
  • Check jinja nested blocks, flatten
  • Fix extra-long function definitions (in documented packages)
  • Check top-bar height, adjust logo height if necessary
  • Fix TODOs and FIXMEs (multiple)
  • Transfer build process to collect_documentation.py
  • Extract theme_tutorial_name variable to examples build (sphinx gallery)

NOTES:

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

dff_sphinx_theme-0.1.21.tar.gz (44.1 kB view details)

Uploaded Source

Built Distribution

dff_sphinx_theme-0.1.21-py2.py3-none-any.whl (58.1 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file dff_sphinx_theme-0.1.21.tar.gz.

File metadata

  • Download URL: dff_sphinx_theme-0.1.21.tar.gz
  • Upload date:
  • Size: 44.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.7.15

File hashes

Hashes for dff_sphinx_theme-0.1.21.tar.gz
Algorithm Hash digest
SHA256 4a380b6da1971647f13038b75d76eb91eb792c6aec924eceaa2a40d1199e5440
MD5 0378b7b4bfed5a4a312c07d326ac6009
BLAKE2b-256 893d5a2595c3058c04a7f0424b3a10f0ffe59721ab261f258a0cda7298a5226d

See more details on using hashes here.

File details

Details for the file dff_sphinx_theme-0.1.21-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for dff_sphinx_theme-0.1.21-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 e110b11924a724679dcfcdb0b9919602e968a57549e2cec2e7e3ffd608f25c93
MD5 f04b9aff150f42fa8f58dcbe1f9e746a
BLAKE2b-256 5d606f2186309fd42b77afc012c980c7f9ce487690ff5a17bd4b37c10907974a

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page