“”

Sphinx Python Documentation Generator and Viewer Sphinx Python Documentation Generator and Viewer
sphinx / stable

Installs a full-fledged Sphinx environment within your TYPO3 website. Builds and renders Sphinx/reStructuredText-based projects such as extension manuals, official reference guides or your own in-house documents as HTML/JSON/PDF either from TYPO3 Backend or from command-line, as you prefer. Features a reStructuredText editor with cross-reference browser and syntax highlighting.

  • 7 LTS
  • 8 LTS

Tags

#documentation #pdf #multilingual #service

Last upload comment

Standard bug fix release.
Editor unfortunately does not properly load with TYPO3 v8, would love getting JS experts to help refactoring it.
Details on https://forge.typo3.org/projects/extension-sphinx/wiki/SPHINX_251

Downloads by version

Author
Xavier Perseguers (Causal)
Last update
05. May 2017
First upload
19. Apr 2013
Downloads
23,781
Category
Backend Modules
Dependencies
  • PHP (5.5.0 - 7.1.99)
  • TYPO3 (7.6.0 - 8.7.99)
Manual
Extension Manual
Ideas or problems?
Get in touch
External repository
Take a look into the code
Like it?
Sponsor development

Installation

  1. Download ZIP file
  2. Log into your TYPO3 backend
  3. Go to Extension Manager module
  4. Press the upload button on the top bar
  5. Select the ZIP file and upload it. If you want to overwrite an existing extension installation, activate the checkbox.
  1. Download T3X file
  2. Log into your TYPO3 backend
  3. Go to Extension Manager module
  4. Press the upload button on the top bar
  5. Select the T3X file and upload it. If you want to overwrite an existing extension installation, activate the checkbox.

Version history

Version Upload comment Works with TYPO3 Download
2.5.1 / stable
May 05, 2017
Standard bug fix release.
Editor unfortunately does not properly load with TYPO3 v8, would love getting JS experts to help refactoring it.
Details on https://forge.typo3.org/projects/extension-sphinx/wiki/SPHINX_251
7.6.0 - 8.7.99 Download ZIP Archive
2.5.0 / stable
January 08, 2017
Drop support for TYPO3 6.2 LTS.
Fix layout problems with TYPO3 8.
Streamline the toolbar.
Details on https://forge.typo3.org/projects/extension-sphinx/wiki/SPHINX_250
7.6.0 - 8.99.99 Download ZIP Archive
2.4.0 / stable
October 03, 2016
Compatibility with TYPO3 6.2 - 8.
New documentation theme for extensions, as seen (soon) on docs.typo3.org.
Details on https://forge.typo3.org/projects/extension-sphinx/wiki/SPHINX_240
6.2.0 - 8.99.99 Download ZIP Archive
2.3.1 / stable
November 10, 2015
Last bits of fine-tuning to be ready for TYPO3 7 LTS.
Details on http://forge.typo3.org/projects/extension-sphinx/wiki/SPHINX_231
6.2.0 - 7.99.99 Download ZIP Archive
2.3.0 / stable
August 18, 2015
Autonomous and much better OpenOffice to Sphinx converter.
Cache-based rendering optimisation & parallel building to highly speed-up generation of documents.
Details on http://forge.typo3.org/projects/extension-sphinx/wiki/SPHINX_230
6.2.0 - 7.99.99 Download ZIP Archive
2.2.3 / stable
April 11, 2015
Detects problems which prevent proper rendering on docs.typo3.org.
Be sure to work in layout "Interactive" to benefit from it.
Details on http://forge.typo3.org/projects/extension-sphinx/wiki/SPHINX_223
6.2.0 - 7.99.99 Download ZIP Archive
2.2.2 / stable
March 17, 2015
Support for sphinx-doc version 1.3 (source repository moved to GitHub).
Details on http://forge.typo3.org/projects/extension-sphinx/wiki/SPHINX_222
6.2.0 - 7.99.99 Download ZIP Archive
2.2.1 / stable
March 03, 2015
Compatibility release for TYPO3 6.2.11-dev and master branch due to former use of internal, non-API methods and behaviour.
Details on http://forge.typo3.org/projects/extension-sphinx/wiki/SPHINX_221
6.2.0 - 7.99.99 Download ZIP Archive
2.2.0 / stable
December 04, 2014
Compatibility with TYPO3 6.2 - 7.x.
Details on https://forge.typo3.org/projects/extension-sphinx/wiki/SPHINX_220
6.2.0 - 7.99.99 Download ZIP Archive
2.1.0 / stable
June 05, 2014
Support for pattern-based external links (e.g., for Forge tickets, TER, ...) and upload of images (or files) with built-in reStructuredText editor.
Details on http://forge.typo3.org/projects/extension-sphinx/wiki/SPHINX_210
6.0.0 - 6.2.99 Download ZIP Archive
2.0.1 / stable
April 20, 2014
Regular maintenance release. Fixes various PHP warnings.
Details on http://forge.typo3.org/projects/extension-sphinx/wiki/SPHINX_201
6.0.0 - 6.2.99 Download ZIP Archive
2.0.0 / stable
April 07, 2014
Rebranded dashboard to easily manage/kickstart custom projects (from template or external git repository).
Enhanced documentation editor (drag and drop, ...) supporting git.
Details on http://forge.typo3.org/projects/extension-sphinx/wiki/SPHINX_200
6.0.0 - 6.2.99 Download ZIP Archive
1.3.2 / stable
March 16, 2014
Properly generates URIs with security token introduced in TYPO3 6.2.
Details on http://forge.typo3.org/projects/extension-sphinx/wiki/SPHINX_132
6.0.0 - 6.2.99 Download ZIP Archive
1.3.1 / stable
January 16, 2014
Crash when converting an OpenOffice manual to Sphinx.
Details on http://forge.typo3.org/projects/extension-sphinx/wiki/SPHINX_131
6.0.0 - 6.2.99 Download ZIP Archive
1.3.0 / stable
January 05, 2014
Syntax highlighting, keyboad shortcuts, auto-mapping for Intersphinx. Details on http://forge.typo3.org/projects/extension-sphinx/wiki/SPHINX_130 6.0.0 - 6.2.99 Download ZIP Archive
1.2.2 / stable
October 15, 2013
Bugfix release and compatibility with TYPO3 6.2 LTS.
Details on http://forge.typo3.org/projects/extension-sphinx/wiki/SPHINX_122
6.0.0 - 6.2.99 Download ZIP Archive
1.2.1 / stable
September 23, 2013
Bugfix. Interactive layout has been broken by attempting to prevent cache problem with browser\'s built-in PDF viewer pdf.js.
Details on http://forge.typo3.org/projects/extension-sphinx/wiki/SPHINX_121
6.0.0 - 6.1.99 Download ZIP Archive
1.2.0 / stable
September 22, 2013
Enhanced reStructuredText/Sphinx built-in editor.
Support for 3rd-party plugins (YouTube/Google Maps/...).
Keep Sphinx environment when upgrading.
Details on http://forge.typo3.org/projects/extension-sphinx/wiki/SPHINX_120
6.0.0 - 6.1.99 Download ZIP Archive
1.1.1 / stable
August 24, 2013
Bugfix release.
Use of online Ace editor has been blacklisted due to abuse.
Fix broken styles in TYPO3 6.2.
Details on http://forge.typo3.org/projects/extension-sphinx/wiki/SPHINX_111
6.0.0 - 6.1.99 Download ZIP Archive
1.1.0 / stable
August 09, 2013
Support for multilingual documentation.
French documentation.
TypoScript highlighting.
Simply register custom projects.
OpenOffice to Sphinx converter.
Extend EXT:documentation (TYPO3 6.2 only).
6.0.0 - 6.1.99 Download ZIP Archive
1.0.0 / stable
July 05, 2013
T3DD13 release.
Extension is now considered stable.
TYPO3 branding with LaTeX for PDF rendering.
[experimental] support of rst2pdf.
6.0.0 - 6.1.99 Download ZIP Archive
0.6.0 / beta
June 18, 2013
Extension is now compatible with MS Windows platform! In addition, signal/slot mechanism has been added to let you register your own documentation in Sphinx Documention Viewer. 6.0.0 - 6.1.99 Download ZIP Archive
0.5.0 / beta
June 04, 2013
Now features an integrated ReStructuredText editor and a revamped documentation viewer for extensions with Sphinx-based manuals. 6.0.0 - 6.1.99 Download ZIP Archive
0.4.0 / beta
May 28, 2013
Now can use globally installed Sphinx as well, if available.
New Backend module: Sphinx documentation viewer to locally render extensions manuals
6.0.0 - 6.1.99 Download ZIP Archive
0.3.0 / beta
May 10, 2013
Better handling of official TYPO3 documentation structure.
Colored console output.
Compilation in PDF if pdflatex is available.
Reworked importer in EM with support for manual build of components.
6.0.0 - 6.2.99 Download ZIP Archive
0.2.0 / alpha
April 27, 2013
Wizard for kickstarting a TYPO3 documentation (with pretty orange HTML template).
Fully capable of cross-linking to official TYPO3 manuals (example included).
Please rebuild your Python environment!
6.0.0 - 6.1.99 Download ZIP Archive
0.1.0 / alpha
April 19, 2013
Initial release to gather feedback. Happy documenting! 6.0.0 - 6.1.99 Download ZIP Archive