mirror of
https://github.com/arsenetar/dupeguru.git
synced 2026-01-22 06:37:17 +00:00
Began serious code documentation effort
Enabled the autodoc Sphinx extension and started adding docstrings to classes, methods, etc.. It's quickly becoming quite interesting...
This commit is contained in:
5
help/en/developer/core/app.rst
Normal file
5
help/en/developer/core/app.rst
Normal file
@@ -0,0 +1,5 @@
|
||||
core.app
|
||||
========
|
||||
|
||||
.. automodule:: core.app
|
||||
:members:
|
||||
5
help/en/developer/core/directories.rst
Normal file
5
help/en/developer/core/directories.rst
Normal file
@@ -0,0 +1,5 @@
|
||||
core.directories
|
||||
================
|
||||
|
||||
.. automodule:: core.directories
|
||||
:members:
|
||||
7
help/en/developer/core/engine.rst
Normal file
7
help/en/developer/core/engine.rst
Normal file
@@ -0,0 +1,7 @@
|
||||
core.engine
|
||||
===========
|
||||
|
||||
.. automodule:: core.engine
|
||||
|
||||
.. autoclass:: core.engine.Group
|
||||
:members:
|
||||
5
help/en/developer/core/fs.rst
Normal file
5
help/en/developer/core/fs.rst
Normal file
@@ -0,0 +1,5 @@
|
||||
core.fs
|
||||
=======
|
||||
|
||||
.. automodule:: core.fs
|
||||
:members:
|
||||
5
help/en/developer/core/gui.rst
Normal file
5
help/en/developer/core/gui.rst
Normal file
@@ -0,0 +1,5 @@
|
||||
core.gui
|
||||
========
|
||||
|
||||
.. automodule:: core.gui
|
||||
:members:
|
||||
5
help/en/developer/core/results.rst
Normal file
5
help/en/developer/core/results.rst
Normal file
@@ -0,0 +1,5 @@
|
||||
core.results
|
||||
============
|
||||
|
||||
.. automodule:: core.results
|
||||
:members:
|
||||
@@ -44,3 +44,16 @@ a list of matches and returns a list of ``Group`` instances (a ``Group`` is basi
|
||||
When a scan is over, the final result (the list of groups from ``get_groups()``) is placed into
|
||||
``app.DupeGuru.results``, which is a ``results.Results`` instance. The ``Results`` instance is where
|
||||
all the dupe marking, sorting, removing, power marking, etc. takes place.
|
||||
|
||||
API
|
||||
---
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
core/app
|
||||
core/fs
|
||||
core/engine
|
||||
core/directories
|
||||
core/results
|
||||
core/gui
|
||||
@@ -54,6 +54,6 @@ Contents:
|
||||
results
|
||||
reprioritize
|
||||
faq
|
||||
developer
|
||||
developer/index
|
||||
changelog
|
||||
credits
|
||||
|
||||
Reference in New Issue
Block a user