Skip to main content
Python Software Foundation 20th Year Anniversary Fundraiser  Donate today!

A Sphinx extension to assist in publishing scientific writing in either HTML or PDF.

Project description

Sphinxience

A Sphinx extension to assist in publishing scientific writing in either HTML or PDF.

This extension mainly consists of a number of roles and directives, so that you can use most LaTeX macros more easily than writing inline LaTeX in Sphinx. This extension will also monkeypatch your HTML theme and LaTeX settings, to make the LaTeX output conform to what is expected of scientific papers submitted to conferences/journals.

Sphinxience is pronounced either like "Sphinx science" or rhyming with "experience". It's up to you.

How to use this

TODO copy an example project that I will make

How to fork this

TODO

Status

Warning: I'm still in the (slow) process of open sourcing this.

TODO There is some stuff in this project but it's still minimal. I'm extracting it out from another project bit by bit. I've only tested the HTML output; the LaTeX style is still pending.

Random stuff

TODO generate documentation from source

General note about code quality: the code here should work and be reasonable clean, but it could e.g. use a linter to catch unused imports. Patches are welcome!

Project details


Download files

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

Files for sphinxience, version 0.2.0
Filename, size File type Python version Upload date Hashes
Filename, size sphinxience-0.2.0-py3-none-any.whl (10.8 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size sphinxience-0.2.0.tar.gz (5.4 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page