Package: setupdocx
The ‘setupdocx‘ provides a control layer for continuous documentation by the simplified creation, packaging, and installation of documentation.
The provided commands are distributed as entry points and optional base classes for further customization intosetup.py- setuptools / distutils.The current release supports the following commands:build_docx- Enhanced documentation.Supports the first integration ofEpydocintoSphinxfor combinedJavadocstyle
documentation ofPythonandJava.
Manages arbitrary document templates for the supported builder,
supports multiple builds with arbitrary document layouts, designs, and patched contents.install_docx- Installs local documentation.Installs documentation locally from build directory, see PEP-0370.dist_docx- Documentation packaging.Creates distribution packages for documentation.build_apidoc- Standalone Generator for API DocumentationExtracts the inline documentation only.
Manages arbitrary document templates for the supported builder,
supports multiple builds with arbitrary document layouts, designs, and patched contents.build_apiref- Standalone Generator for API ReferenceExtracts the inline documentation as JavaDoc style API reference.
Manages arbitrary document templates for the supported builder,
supports multiple builds with arbitrary document layouts, designs, and patched contents.For more extensions refer to the online documentation.Online documentation:https://setupdocx.sourceforge.io/Runtime-Repository:PyPI:https://pypi.org/project/setupdocx/Install:pip install setupdocx, see also section ‘Install’ of the online documentation.Downloads:sourceforge.net:https://sourceforge.net/projects/setupdocx/files/bitbucket.org:https://bitbucket.org/acue/setupdocxgithub.com:https://github.com/ArnoCan/setupdocx/pypi.org:https://pypi.org/project/setupdocx/Project DataPROJECT: ‘setupdocx’MISSION: Command extension ofsetup.pyfor multi-platform and documentation deployments.VERSION: 00.01RELEASE: 00.01.022STATUS: betaAUTHOR: Arno-Can UestuensoezCOPYRIGHT: Copyright (C) 2019 Arno-Can Uestuensoez @Ingenieurbuero Arno-Can UestuensoezLICENSE: Artistic-License-2.0 + Forced-Fairplay-ConstraintsConcepts and enumeration values are migrated from theUnifiedSessionsManager(C) 2008 Arno-Can Uestuensoez @Ingenieurbuero Arno-Can Uestuensoez.SphinxTested with Sphinx-1.7 on Python2.7.14, and Python3.6.5.Runtime EnvironmentFor a comprehensive list refer to the documentation.Python Syntax SupportPython2.7, and Python3Python Implementation SupportCPython, IPython, IronPython, Jython, and PyPyOS on Server, Workstation, Laptops, Virtual Machines, and ContainersLinux: AlpineLinux, ArchLinux, CentOS, Debian, Fedora, Gentoo, OpenSUSE, Raspbian, RHEL, Slackware, SLES, Ubuntu, …BSD: DragonFlyBSD, FreeBSD, NetBSD, OpenBSD, GhostBSD, TrueOS, NomadBSDOS-X: Snow LeopardWindows: Win10, Win8.1, Win7, WinXP, Win2019, Win2016, Win2012, Win2008, Win2000WSL-1.0: Alpine, Debian, KaliLinux, openSUSE, SLES, UbuntuCygwinUNIX: Solaris10, Solaris11Minix: Minix3ReactOSNetwork and SecurityNetwork Devices: OpenWRTSecurity: KaliLinux, pfSenseOS on Embedded DevicesRaspberryPI: ArchLinux, CentOS, OpenBSD, OpenWRT, RaspbianASUS-TinkerBoard: ArmbianCurrent ReleaseREMARK:Currently tested by application to the other projects of the author.
So for now no package tests defined.Major Changes:Initial version.Issues:Current release supportsshellonly and is released forbash, so
safe to use onPOSIXplatforms.
So may should onWindows-10et.al. /NT-10.0, in any case inWSL.
General support forWindowsplatforms is coming soon - so the full scale
of platforms will be supported.ToDo:make all templates completely generic for any package - some like ‘man’ contain hardcoded names for setupdocxAdd optional gzip to man pages.Add rpm, deb, apk.Known Issues:Not yet