Home

Recent
Archive

Numerical experiments, Tips, Tricks and Gotchas

Numerically speaking

Creating a static website with Sphinx

1. Introduction

Sphinx [1], [2] , [3] is a documentation tool originally created for documenting Python projects. Recently I got the idea that Sphinx can be used as a static website generator. A quich Google search revealed that I was not alone. This subject was discussed at Stack Overflow [4] and Quora [5]. I decided to collect the links to the existing approaches rather than to reinvent the wheel.

2. Direct use of Sphinx

There are several posts about using Sphinx as a static webpage generator:

3. Sphinx based website generators

Tinkerer is a blogging engine/static website generator powered by Sphinx [10].

4. Hosting

4.1. Readthedocs

Documentation using Sphinx and ReadTheDocs.org [11] .

4.2 GitHub

4.3. Bitbucket

This undocumented Bitbucket Pages feature allows to host simple HTML web pages from a Bitbucket repositories [17].

4.4. PythonAnywhere

PythonAnywhere Forums. How do to host a static page [18].

Setting up Pelican on PythonAnywhere [19].

References

  1. Sphinx (documentation generator)
  2. Sphinx overview
  3. Sphinx documentation denerator - Links
  4. Using Sphinx to write personal websites and blogs
  5. What's the best available static blog/website generator in Python?
  6. Amit Saha, Sphinx as a Static Site Generator
  7. Daniel Rocco, Template Driven Websites with Sphinx
  8. Shichao An, Create a personal website with Sphinx
  9. Jeroen Leijen, How to use Sphinx to build your website
  10. Tinkerer - Blogging for Pythonistas
  11. Documentation using Sphinx and ReadTheDocs.org
  12. How to upload html documentation generated from sphinx to github?
  13. Ben Welsh, Sphinx documentation on GitHub
  14. Nikhil, Automatic Github Pages generation from Sphinx documentation
  15. Publishing sphinx-generated docs on github
  16. Create a developer documentation with sphinx and github
  17. John Ankarström, Bitbucket Pages
  18. PythonAnywhere Forums. How do to host a static page
  19. Setting up Pelican on PythonAnywhere

 

© Nikolai Shokhirev, 2012-2017

email: nikolai(dot)shokhirev(at)gmail(dot)com

Count: