Metadata-Version: 2.1
Name: sphinxience
Version: 0.2.2
Summary: A Sphinx extension to assist in publishing scientific writing in either HTML or PDF.
Home-page: https://github.com/bgeron/sphinxience
License: MIT
Author: Bram Geron
Author-email: bram@bram.xyz
Requires-Python: >=3.0,<4.0
Classifier: Development Status :: 4 - Beta
Classifier: Framework :: Sphinx :: Extension
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Topic :: Documentation :: Sphinx
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Scientific/Engineering :: Mathematics
Requires-Dist: Sphinx (>=1.7,<1.8)
Requires-Dist: alabaster (>=0.7,<0.8)
Description-Content-Type: text/markdown

# 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!


