Welcome ======= .. image:: /_static/dompteur_logo.png :align: center :width: 70% **Dompteur** is an installation and configuration tool for `Sphinx `_, the documentation generator. .. warning:: This all is currently just an idea. No code exists, just some mockups and specs. I hope this all will be realized in some weeks, maybe months :) So sorry for the documentation mess, it may show different status of the project, which are kept mostly for ongoing discussions. It helps users to have a central place for configuration around all elements of the Sphinx universe: **Creating** - Sphinx & extension selection - Creating a Python virtual environment and installing all dependencies - Executing ``sphinx-quickstart`` **Configuring** - Showing ``conf.py`` in editor (allows direct manipulations) - Showing used conf-vars as gui-elements - Allow search and usage of possible conf-vars **Building** - Overview of all local Sphinx projects at one place - Providing preconfigured, most efficient build setups - Allow graphical configurations and triggering of builds **Deploying** * Python virtual environment for Sphinx builds * VSCode/Pycharm configs for building docs * ReadTheDocs and github Actions configurations The name Dompteur ----------------- **Dompteur** is the french wording for an animal tamer. It is also well known in the german language. We thought it is a nice name for a tool which tries to tame Sphinx projects. If not known, a Sphinx is a mystical creature with the head of a human, the body of a **lion** with the wings of a **falcon**. It is pronounced `like this `_ (opens a sound file). Contents -------- .. toctree:: :maxdepth: 2 technic mockups workflows Ideas ----- Rough gui layout ~~~~~~~~~~~~~~~~ Based on the layout of the new Qubes Configuration tool Left sidebar, which shows the current config category (install, extensions, config, venv, shortcuts, ...) Features ~~~~~~~~ * Can create new projects and maintain existing ones * New projects shall contain * preconfigured sphinx project * venv * Shortcuts on desktop and wherever for build and open docs * Config for vscode/pycharm runners (e.g. .vscode folder) * (Updated) .gitignore * Github actions config to build docs * ReadTheDocs config for easy deployment * Config window, which knows what config options are available * Options are searchable * Options can be registered by Extensions * There is be preconfigured list of options by dompteur for most important stuff * Config templates from user home directory * Know existing sphinx-docs by storing confing in home directory * Allow to add existing projects * Can build docs and open browser/editor/presenter directly * Has build history and stores result and duration Technical stuff ~~~~~~~~~~~~~~~ * python script to extrac tconfig options from docs and store them in dompteur-config file (e.g. readthedocs, sphinx-needs) * dompteur config-file, which can be used reproducible setup on new machines (for venv, runners, desktop shortcuts, ...)