mirror of
https://github.com/arsenetar/dupeguru.git
synced 2026-01-22 06:37:17 +00:00
Reorganized hscommon documentation
Removed hscommon's "docs" folder and moved all documentation directly into docstrings. Then, in dupeGuru's developer documentation, added autodoc references to relevant modules. The result is a much more usable hscommon documentation.
This commit is contained in:
12
help/en/developer/core/index.rst
Normal file
12
help/en/developer/core/index.rst
Normal file
@@ -0,0 +1,12 @@
|
||||
core
|
||||
====
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
app
|
||||
fs
|
||||
engine
|
||||
directories
|
||||
results
|
||||
gui
|
||||
5
help/en/developer/hscommon/build.rst
Normal file
5
help/en/developer/hscommon/build.rst
Normal file
@@ -0,0 +1,5 @@
|
||||
hscommon.build
|
||||
==============
|
||||
|
||||
.. automodule:: hscommon.build
|
||||
:members:
|
||||
5
help/en/developer/hscommon/conflict.rst
Normal file
5
help/en/developer/hscommon/conflict.rst
Normal file
@@ -0,0 +1,5 @@
|
||||
hscommon.conflict
|
||||
=================
|
||||
|
||||
.. automodule:: hscommon.conflict
|
||||
:members:
|
||||
5
help/en/developer/hscommon/desktop.rst
Normal file
5
help/en/developer/hscommon/desktop.rst
Normal file
@@ -0,0 +1,5 @@
|
||||
hscommon.desktop
|
||||
================
|
||||
|
||||
.. automodule:: hscommon.desktop
|
||||
:members:
|
||||
12
help/en/developer/hscommon/index.rst
Normal file
12
help/en/developer/hscommon/index.rst
Normal file
@@ -0,0 +1,12 @@
|
||||
hscommon
|
||||
========
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
build
|
||||
conflict
|
||||
desktop
|
||||
notify
|
||||
path
|
||||
util
|
||||
5
help/en/developer/hscommon/notify.rst
Normal file
5
help/en/developer/hscommon/notify.rst
Normal file
@@ -0,0 +1,5 @@
|
||||
hscommon.notify
|
||||
===============
|
||||
|
||||
.. automodule:: hscommon.notify
|
||||
:members:
|
||||
5
help/en/developer/hscommon/path.rst
Normal file
5
help/en/developer/hscommon/path.rst
Normal file
@@ -0,0 +1,5 @@
|
||||
hscommon.path
|
||||
=============
|
||||
|
||||
.. automodule:: hscommon.path
|
||||
:members:
|
||||
5
help/en/developer/hscommon/util.rst
Normal file
5
help/en/developer/hscommon/util.rst
Normal file
@@ -0,0 +1,5 @@
|
||||
hscommon.util
|
||||
=============
|
||||
|
||||
.. automodule:: hscommon.util
|
||||
:members:
|
||||
@@ -53,9 +53,5 @@ API
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
core/app
|
||||
core/fs
|
||||
core/engine
|
||||
core/directories
|
||||
core/results
|
||||
core/gui
|
||||
core/index
|
||||
hscommon/index
|
||||
|
||||
Reference in New Issue
Block a user