https://github.com/rmohr/sphinx-server

A minimalistic server for uploading and viewing sphinx documentation
https://github.com/rmohr/sphinx-server

Last synced: 22 days ago
JSON representation

A minimalistic server for uploading and viewing sphinx documentation

• Host: GitHub
• URL: https://github.com/rmohr/sphinx-server
• Owner: rmohr
• License: gpl-3.0
• Created: 2013-05-26T19:51:34.000Z (over 11 years ago)
• Default Branch: master
• Last Pushed: 2013-08-19T13:23:32.000Z (about 11 years ago)
• Last Synced: 2024-10-19T18:47:40.950Z (30 days ago)
• Language: Python
• Size: 137 KB
• Stars: 6
• Watchers: 3
• Forks: 4
• Open Issues: 1
• Metadata Files:
  • Readme: README.rst
  • License: COPYING

Awesome Lists containing this project

README

        
.. -*- mode: rst; coding: utf-8 -*-

sphinx-server - A minimalistic server for uploading and viewing sphinx documentation

====================================================================================

.. image:: https://secure.travis-ci.org/rmohr/sphinx-server.png?branch=master

:Authors: Roman Mohr 

:Version: 0.1.0

:Date: 2013-08-16

:Code: https://github.com/rmohr/sphinx-server

.. contents:: Table of Contents

  :backlinks: top

sphinx-server is a minimal sphinx documentation hosting server. It is

compatible with Sphinx-PyPi-upload_. To view the documentation static3_ is

used.

Installation and Usage

----------------------

Install sphinx-server::

    pip install sphinx-server

or from GitHub::

    git clone git://github.com/rmohr/sphinx-server.git

    cd sphinx-server

    pip install .

gunicorn

^^^^^^^^

Download the WSGI HTTP Server::

    pip install gunicorn

Run the server::

    gunicorn -w 1 'sphinxserver:app(home="root/folder")' -b 127.0.0.1:8080

Upload the documentation of your project::

    cd /your/project/path

    python setup.py upload_sphinx --repository=http://127.0.0.1:8080

Browse the documentation::

    firefox http://127.0.0.1:8080/your_project_name/

.. _Sphinx-PyPI-upload: https://pypi.python.org/pypi/Sphinx-PyPI-upload

.. _static3: https://pypi.python.org/pypi/static3

pastedeploy

^^^^^^^^^^^

Alternatively spinx-server can be run via pastedeploy. An example.ini

might look like this::

    [app:main]

    use = egg:sphinx-server#main

    home= ~/sphinx-docs

    [server:main]

    use = egg:gunicorn#main

    host = 0.0.0.0

    port = 9000

    workers = 5

    accesslog = -

Install the WSGI HTTP Server::

    pip install gunicorn pastedeploy

Run the server::

    gunicorn_paster example.ini