Mockups¶
This page collects mockups of different windows and their layout.
To understand, when which window is used, take a look into Workflows
Contents
Main starting window¶
![@startuml
salt
{
<b>Dompteur Start Page
.
{
Project A | [Build <&beaker>] | ^HTML^ | [Show <&eye>] | --- | [ Configure <&cog> ]
Project B | [Build <&beaker>] | ^PDF ^ | [Show <&eye>] | --- | [ Configure <&cog> ]
Project C | [Build <&beaker>] | ^HTML^ | [Show <&eye>] |--- | [ Configure <&cog> ]
}
.
{
[ Create new project ] | [ Import existing project ]
}
}
@enduml](_images/plantuml-cfaccf4de0637b27b559e34f96a117e082c6763f.png)
Create new project¶
Sphinx config¶
![@startuml
salt
{
{
<b>Create new project
Configure the main parts of your sphinx project.
(mainly "sphinx-quickstart" options)
.
}
{
Target folder | "/home/me/project_new/docs "
Project name | "Project New"
Project author | "Team New"
[X] Separate build folder
Project version | "1.0"
Sphinx version| ^Sphinx 5.1^
}
--
{
[<b>Next] | [Cancel]
}
}
@enduml](_images/plantuml-c9830414c7887aa2d13bc27112b3af4210d46f2b.png)
Project creation status¶
![@startuml
salt
{
{
<b>Creating project
Your project is getting installed and configured.
Sit back and relax. It only needs some moments.
.
}
{
<b>Status
(X) Venv setup | --> |(X) Deps install | --> | (X) Sphinx project | --> | () conf.py update | --> | () Initial build
}
.
{
<b>Console output
{SI
loading pickled environment... done
building [mo]: targets for 0 po files that are out of date
building [html]: targets for 1 source files that are out of date
updating environment: 0 added, 1 changed, 0 removed
reading sources... [100%] mockups
looking for now-outdated files... none found
pickling environment... done
checking consistency... done
preparing documents... done
writing output... [ 50%] index
writing output... [100%] mockups
}
}
--
{
[<b>Done]
}
}
@enduml](_images/plantuml-7596f417b1d97cd04840fb34ad5bcc4bc48097f8.png)
Extension selection¶
This window can be used for new and existing projects to select extensions.
![@startuml
salt
{
{
<b>Select Extensions
Search for extensions and add them to the project.
.
}
{
{Filter: | " "}
Available Extensions | .| . | Selected extensions
{SI
Sphinx-Needs
Sphinxcontrib-Plantuml
**Sphinx-Copybutton**
Sphinx-Collections
Sphinx-Simplepdf
} | [ add ] | [ remove ] |
{SI
Sphinx-Copybutton
Sphinx-Simplepdf
.
.
.
}
}
{
<b>Extension information
Lorem ipsum and so ... lorem ipsum and so ... lorem ipsum and so ...
lorem ipsum and so ...
}
--
{
[<b>Next] | [Cancel]
}
}
@enduml](_images/plantuml-ec246daf9c3f5b6cb60fcd202f0241ca7bed3db8.png)
Env configuration¶
This window can be used for new and existing projects to select extensions.
![@startuml
salt
{
{
<b>Configure Environments
.
<b>Python Environment
{ ^Create new virtual ENV^ }
{Folder | "/home/me/project_new/docs/.venv"}
.
<b>IDE Environments
Adds preconfigured jobs for your IDE, so that HTML and PDF builds can be started
in the IDE with just one click.
.
[X] Add VsCode tasks config
[X] Add PyCharm runner config
.
The next step will create the Venv, installs Sphinx and all selected extensions,
and finally setups a new Sphinx project.
}
--
{
[<b>Create project] | [Cancel]
}
}
@enduml](_images/plantuml-143dc5839604f7feae86755cf17edfc2f1357801.png)
