Sphinx - три отличные ссылки и два посредственных видео

Sphinx - это фреймворк для создания статичных сайтов. Его используют не только для создания мануалов с фрагментами кода, но и для написания книг. Я давно ищу варианты не только для книг, но и для совместных исследований... Здесь можно использовать простые текстовые шаблоны страниц... и много чего еще...

Первоисточники и ссылки¶

First Steps with Sphinx This document is meant to give a tutorial-like overview of all common tasks while using Sphinx.
Easy and beautiful documentation with Sphinx
Good examples of Python docstrings for Sphinx

Вот короткое видео, в котором есть почти все.

Я похвалил этого автора Introduction to Pandas and Vincent, теперь пришла пора разобрать его видео про Sphinx. Однако, здесь разрешение 360...

In [2]:

help('sphinx')

Help on package sphinx:

NAME
    sphinx

FILE
    c:\users\kiss\anaconda\lib\site-packages\sphinx\__init__.py

DESCRIPTION
    Sphinx
    ~~~~~~
    
    The Sphinx documentation toolchain.
    
    :copyright: Copyright 2007-2013 by the Sphinx team, see AUTHORS.
    :license: BSD, see LICENSE for details.

PACKAGE CONTENTS
    addnodes
    apidoc
    application
    builders (package)
    cmdline
    config
    directives (package)
    domains (package)
    environment
    errors
    ext (package)
    highlighting
    jinja2glue
    locale (package)
    make_mode
    pycode (package)
    pygments_styles
    quickstart
    roles
    search (package)
    setup_command
    theming
    transforms
    util (package)
    versioning
    websupport (package)
    writers (package)

FUNCTIONS
    main(argv=['-c', '-f', r'C:\Users\kiss\.ipython\profile_default\security\kernel-0cbd7624-a5f9-471b-a0e8-e949d5775ed8.json', "--IPKernelApp.parent_appname='ipython-notebook'", '--profile-dir', r'C:\Users\kiss\.ipython\profile_default', '--interrupt=1684', '--parent=1688'])
        Sphinx build "main" command-line entry.
    
    make_main(argv=['-c', '-f', r'C:\Users\kiss\.ipython\profile_default\security\kernel-0cbd7624-a5f9-471b-a0e8-e949d5775ed8.json', "--IPKernelApp.parent_appname='ipython-notebook'", '--profile-dir', r'C:\Users\kiss\.ipython\profile_default', '--interrupt=1684', '--parent=1688'])
        Sphinx build "make mode" entry.

DATA
    __released__ = '1.2.1'
    __version__ = '1.2.1'
    package_dir = r'C:\Users\kiss\Anaconda\lib\site-packages\sphinx'
    version_info = (1, 2, 1, 'final', 0)

VERSION
    1.2.1

Посты чуть ниже также могут вас заинтересовать