1.2.3: issue with generating sphinx documentation for sqlalchemy

[kloczek]

Generally looks like your sphinx extension causes some that sphinx cannot generate documentation. Could you please have a look on https://github.com/sqlalchemy/sqlalchemy/issues/5906 where are all details?

[zzzeek]

hi there -

this is the same organization, zzzeeksphinx works with HTML and to some extent LaTeX files only. There is no explicit support for "man" form.

[kloczek]

There is no explicit support for "man" form.

Man pages are usually basic format of the documentation for most of the U*nix user/developers.

[tkloczko@barrel SPECS]$ man python-<tab><tab>
Display all 168 possibilities? (y or n)
python-amqp                           python-hyperlink                      python-productmd-compose              python-sphinxcontrib-httpdomain
python-anytree                        python-hypothesis                     python-productmd-composeinfo          python-sphinxcontrib-trio
python-arrow                          python-ifaddr                         python-productmd-discinfo             python-sphinx-hoverxref
python-"asgi                          python-importlib-metadata             python-productmd-images               python-sphinx-removed-in
python-aspectlib                      python-inflect                        python-productmd-rpms                 python-sphinx_rtd_theme
python-astor                          python-itsdangerous                   python-productmd-terminology          python-sphinx-tabs
python-astroid                        python-jaraco-classes                 python-productmd-treeinfo             python-sphinx-typlog-theme
python-async_generator                python-jaraco-envs                    python-prompt_toolkit                 python-sphobjinv
python-attrs                          python-jaraco-functools               python-ptyprocess                     python-sqlparse
python-babel                          python-jaraco.itertools               python-purl                           python-sure
python-backcall                       python-jaraco-packaging               python-py                             python-sybil
python-betamax                        python-jaraco-text                    python-pycodestyle                    python-systemd
python-billiard                       python-jedi                           python-pyfakefs                       python-testpath
python-blinker                        python-Jinja                          python-pygal                          python-testrepository
python-boto3                          python-jmespath                       python-pygments                       python-testtools
python-botocore                       python-kombu                          python-pyhamcrest                     python-tidy
python-bottle                         python-lark                           python-pylint                         python-tinycss2
python-breathe                        python-lazy-object-proxy              python-pynacl                         python-tornado
python-build                          python-libevdev                       python-pyopenssl                      python-traitlets
python-cachetools                     python-lockfile                       python-pyrad                          python-trio
python-case                           python-lxml                           python-pyrsistent                     python-trustme
python-cffi                           python-mako                           python-pyscss                         python-twisted
python-click                          python-markupsafe                     python-pytest                         python-urllib3
python-coveragepy                     python-mistune                        python-pytest-checkdocs               python-vine
python-cssselect2                     python-more-itertools                 python-pytest-cov                     python-waitress
python-dateutil                       python-msgpack                        python-pytest-runner                  python-wcwidth
python-dpkt                           python-multidict                      python-python-sphinx-contribspelling  python-webcolors
python-dulwich                        python-mypy                           python-pyudev                         python-webencodings
python-elementpath                    python-netaddr                        python-pyxattr                        python-webob
python-evdev                          python-nose2                          python-rdflib                         python-websocket-client
python-faker                          python-olefile                        python-requests                       python-websockets
python-flask                          python-openstackdocstheme             python-requests-mock                  python-webtest
python-flask-sqlalchemy               python-outcome                        python-requests_toolbelt              python-werkzeug
python-fonttools                      python-paramiko                       python-rsa                            python-wheel
python-gcovr                          python-parso                          python-rst.linker                     python-wrapt
python-gidocgen                       python-parver                         python-semantic-version               python-WSGIProxy2
python-gitdb                          python-paste                          python-service-identity               python-xmlschema
python-GitPython.tex                  python-path                           python-smartypants                    python-yamlloader
python-greenlet                       python-pillow                         python-smmap.tex                      python-yarl
python-h2                             python-pluggy                         python-sniffio                        python-zeroconf
python-hacking                        python-polib                          python-sphinxcontrib-asyncio          python-zipp
python-hyperframe                     python-prb                            python-sphinxcontrib-autoprogram      python-zope-event

I don't know enough about sphinx internals however I think that exact extension does not need to know to much about rendered output (or I'm wrong?)

Rely please have a look on that issue because it may be relatively easy to solve .. Please ..

[zzzeek]

Hi -

zzzeeksphinx is open source, if you need it to work for man pages, you should work on that! thanks.

[zzzeek]

most likely, just use a different theme for man pages, SQLAlchemy's docs are in .rst.