ENOS Docs theme for Sphinx


License
MIT
Install
pip install sphinx-enos-theme==0.2.22

Documentation

sphinx_enos_theme

Change Log

0.2.5

  • change note css

0.2.4

  • adjust table css

0.2.3

  • remove PDF download button

0.2.2

  • add config display_header default true
  • add config copyright_en and copyright_zh
  • fix some bug

0.2.1

  • header update

0.1.4

  • show image as Full screen mode
  • change toc deep to 8
  • add about chanel
  • fix some language bugs

0.1.3

  • Auto scroll to current selected toc
  • Add + to the node, if there are any children under it

0.1.2

  • Change toc deep to 4
  • Hide current page toc from global toc tree
  • Fix a small bug

0.1.1

  • Change selected toc style
  • Add PDF download button
  • Add version change dropdown list

Usage:

pip install sphinx_enos_theme

Change conf.py

html_theme = "sphinx_enos_theme"

Contribute

Use gulp webpack to compile CSS/JS and HTML template

Dependencies

  • Python >= 2.7
  • node >= 9.0
  • gulp >= 4.0
  • webpack >= 4.0
  • sphinx

Before development

go to src/templates/layout.html, uncomment line 151 & comment line 153

  • prepare dev
gulp pre
  • start dev server
gulp

publish new version

go to src/templates/layout.html, comment line 151 and uncomment line 153

update the version number in init.py

  • build dist
gulp build
  • dist python package
python setup.py sdist
  • publish
twine upload dist/*