Skip to content

Commit

Permalink
Name things once
Browse files Browse the repository at this point in the history
  • Loading branch information
s0undt3ch committed Apr 14, 2021
1 parent 699c1b3 commit a2cc433
Show file tree
Hide file tree
Showing 66 changed files with 492 additions and 459 deletions.
2 changes: 1 addition & 1 deletion .pre-commit-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ repos:
- id: unimport
name: Remove unused imports
args: [--remove]
exclude: ^(docs/.*\.py|src/saltfactories/factories/(cli|daemons)/__init__\.py)$
exclude: ^(docs/.*\.py|src/saltfactories/(cli|daemons)/__init__\.py)$

- repo: https://github.com/asottile/reorder_python_imports
rev: v2.4.0
Expand Down
16 changes: 4 additions & 12 deletions .pylint-spelling-words
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,7 @@ containerfactory
cp
css
cwd
daemonfactory
daemonfactoryimpl
daemonimpl
darwin
datatypes
datetime
Expand Down Expand Up @@ -101,7 +100,6 @@ png
popen
pragma
prepend
processfactory
processresult
proxied
psutil
Expand All @@ -119,19 +117,14 @@ ret
returncode
rst
rtype
saltapifactory
saltcloudfactory
saltapi
saltcloud
saltenv
saltfactories
saltfactory
saltmaster
saltmasterfactory
saltminion
saltminionfactory
saltproxyminion
saltproxyminionfactory
saltsyndic
saltsyndicfactory
shellresult
sigterm
sitecustomise
Expand All @@ -149,8 +142,7 @@ stdout
str
subprocess
subprocesses
subprocessfactorybase
subprocessfactoryimpl
subprocessimpl
sunos
syndic
sys
Expand Down
1 change: 1 addition & 0 deletions changelog/50.improvement.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
* `Name things once <https://www.youtube.com/watch?v=1__lNTlj1_w>`_.
Original file line number Diff line number Diff line change
@@ -1,4 +1,7 @@
.. automodule:: saltfactories.factories.base
Base Classes
============

.. automodule:: saltfactories.bases
:members:
:show-inheritance:
:inherited-members:
Expand Down
9 changes: 9 additions & 0 deletions docs/ref/saltfactories/cli/call.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
=============
``salt-call``
=============

.. automodule:: saltfactories.cli.call
:members:
:show-inheritance:
:inherited-members:
:no-undoc-members:
9 changes: 9 additions & 0 deletions docs/ref/saltfactories/cli/cloud.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
==============
``salt-cloud``
==============

.. automodule:: saltfactories.cli.cloud
:members:
:show-inheritance:
:inherited-members:
:no-undoc-members:
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
.. automodule:: saltfactories.factories.cli.cp
===========
``salt-cp``
===========

.. automodule:: saltfactories.cli.cp
:members:
:show-inheritance:
:inherited-members:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
.. automodule:: saltfactories.factories.cli.key
============
``salt-key``
============

.. automodule:: saltfactories.cli.key
:members:
:show-inheritance:
:inherited-members:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
.. automodule:: saltfactories.factories.cli.run
============
``salt-run``
============

.. automodule:: saltfactories.cli.run
:members:
:show-inheritance:
:inherited-members:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
.. automodule:: saltfactories.factories.cli.salt
========
``salt``
========

.. automodule:: saltfactories.cli.salt
:members:
:show-inheritance:
:inherited-members:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
.. automodule:: saltfactories.factories.cli.spm
=======
``spm``
=======

.. automodule:: saltfactories.cli.spm
:members:
:show-inheritance:
:inherited-members:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
.. automodule:: saltfactories.factories.cli.ssh
============
``salt-ssh``
============

.. automodule:: saltfactories.cli.ssh
:members:
:show-inheritance:
:inherited-members:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
.. automodule:: saltfactories.factories.cli.client
============
Local Client
============

.. automodule:: saltfactories.client
:members:
:show-inheritance:
:inherited-members:
Expand Down
8 changes: 8 additions & 0 deletions docs/ref/saltfactories/daemons/api.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
============
``salt-api``
============
.. automodule:: saltfactories.daemons.api
:members:
:show-inheritance:
:inherited-members:
:no-undoc-members:
9 changes: 9 additions & 0 deletions docs/ref/saltfactories/daemons/container.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
==========
Containers
==========

.. automodule:: saltfactories.daemons.container
:members:
:show-inheritance:
:inherited-members:
:no-undoc-members:
9 changes: 9 additions & 0 deletions docs/ref/saltfactories/daemons/master.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
===============
``salt-master``
===============

.. automodule:: saltfactories.daemons.master
:members:
:show-inheritance:
:inherited-members:
:no-undoc-members:
9 changes: 9 additions & 0 deletions docs/ref/saltfactories/daemons/minion.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
===============
``salt-minion``
===============

.. automodule:: saltfactories.daemons.minion
:members:
:show-inheritance:
:inherited-members:
:no-undoc-members:
9 changes: 9 additions & 0 deletions docs/ref/saltfactories/daemons/proxy.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
==============
``salt-proxy``
==============

.. automodule:: saltfactories.daemons.proxy
:members:
:show-inheritance:
:inherited-members:
:no-undoc-members:
Original file line number Diff line number Diff line change
@@ -1,4 +1,7 @@
.. automodule:: saltfactories.factories.daemons.sshd
========
``sshd``
========
.. automodule:: saltfactories.daemons.sshd
:members:
:show-inheritance:
:inherited-members:
Expand Down
5 changes: 0 additions & 5 deletions docs/ref/saltfactories/factories/cli/call.rst

This file was deleted.

5 changes: 0 additions & 5 deletions docs/ref/saltfactories/factories/cli/cloud.rst

This file was deleted.

5 changes: 0 additions & 5 deletions docs/ref/saltfactories/factories/daemons/api.rst

This file was deleted.

5 changes: 0 additions & 5 deletions docs/ref/saltfactories/factories/daemons/container.rst

This file was deleted.

5 changes: 0 additions & 5 deletions docs/ref/saltfactories/factories/daemons/master.rst

This file was deleted.

5 changes: 0 additions & 5 deletions docs/ref/saltfactories/factories/daemons/minion.rst

This file was deleted.

5 changes: 0 additions & 5 deletions docs/ref/saltfactories/factories/daemons/proxy.rst

This file was deleted.

39 changes: 0 additions & 39 deletions docs/ref/saltfactories/factories/index.rst

This file was deleted.

5 changes: 0 additions & 5 deletions docs/ref/saltfactories/factories/manager.rst

This file was deleted.

37 changes: 36 additions & 1 deletion docs/ref/saltfactories/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,41 @@ Salt Factories Package

cli
plugins/index
factories/index
utils/index
exceptions

Factories
=========

.. toctree::

bases
manager

Daemons
-------

.. toctree::

daemons/master
daemons/minion
daemons/proxy
daemons/api
daemons/sshd
daemons/container


CLI
---

.. toctree::

cli/key
cli/salt
cli/call
cli/run
cli/cp
cli/cloud
cli/spm
cli/ssh
client
9 changes: 9 additions & 0 deletions docs/ref/saltfactories/manager.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
======================
Salt Factories Manager
======================

.. automodule:: saltfactories.manager
:members:
:show-inheritance:
:inherited-members:
:no-undoc-members:
4 changes: 2 additions & 2 deletions setup.cfg
Original file line number Diff line number Diff line change
Expand Up @@ -57,9 +57,9 @@ extras_require =

[options.entry_points]
console_scripts =
salt-factories = saltfactories.cli:main
salt-factories = saltfactories.__main__:main
pytest11=
salt-factories = saltfactories.plugin
salt-factories = saltfactories.plugins
salt-factories-factories = saltfactories.plugins.factories
salt-factories-markers = saltfactories.plugins.markers
salt-factories-sysinfo = saltfactories.plugins.sysinfo
Expand Down
File renamed without changes.

0 comments on commit a2cc433

Please sign in to comment.