mirror of
https://github.com/arsenetar/dupeguru.git
synced 2026-01-22 06:37:17 +00:00
Update site to include help
- Add sphinx documentation generated from build to help - Add link to help (in english) in header - Add link to github in header
This commit is contained in:
5
help/en/_sources/developer/core/app.rst.txt
Normal file
5
help/en/_sources/developer/core/app.rst.txt
Normal file
@@ -0,0 +1,5 @@
|
||||
core.app
|
||||
========
|
||||
|
||||
.. automodule:: core.app
|
||||
:members:
|
||||
5
help/en/_sources/developer/core/directories.rst.txt
Normal file
5
help/en/_sources/developer/core/directories.rst.txt
Normal file
@@ -0,0 +1,5 @@
|
||||
core.directories
|
||||
================
|
||||
|
||||
.. automodule:: core.directories
|
||||
:members:
|
||||
36
help/en/_sources/developer/core/engine.rst.txt
Normal file
36
help/en/_sources/developer/core/engine.rst.txt
Normal file
@@ -0,0 +1,36 @@
|
||||
core.engine
|
||||
===========
|
||||
|
||||
.. automodule:: core.engine
|
||||
|
||||
.. autoclass:: Match
|
||||
|
||||
.. autoclass:: Group
|
||||
:members:
|
||||
|
||||
.. autofunction:: build_word_dict
|
||||
.. autofunction:: compare
|
||||
.. autofunction:: compare_fields
|
||||
.. autofunction:: getmatches
|
||||
.. autofunction:: getmatches_by_contents
|
||||
.. autofunction:: get_groups
|
||||
.. autofunction:: merge_similar_words
|
||||
.. autofunction:: reduce_common_words
|
||||
|
||||
.. _fields:
|
||||
|
||||
Fields
|
||||
------
|
||||
|
||||
Fields are groups of words which each represent a significant part of the whole name. This concept
|
||||
is sifnificant in music file names, where we often have names like "My Artist - a very long title
|
||||
with many many words".
|
||||
|
||||
This title has 10 words. If you run as scan with a bit of tolerance, let's say 90%, you'll be able
|
||||
to find a dupe that has only one "many" in the song title. However, you would also get false
|
||||
duplicates from a title like "My Giraffe - a very long title with many many words", which is of
|
||||
course a very different song and it doesn't make sense to match them.
|
||||
|
||||
When matching by fields, each field (separated by "-") is considered as a separate string to match
|
||||
independently. After all fields are matched, the lowest result is kept. In the "Giraffe" example we
|
||||
gave, the result would be 50% instead of 90% in normal mode.
|
||||
5
help/en/_sources/developer/core/fs.rst.txt
Normal file
5
help/en/_sources/developer/core/fs.rst.txt
Normal file
@@ -0,0 +1,5 @@
|
||||
core.fs
|
||||
=======
|
||||
|
||||
.. automodule:: core.fs
|
||||
:members:
|
||||
@@ -0,0 +1,5 @@
|
||||
core.gui.deletion_options
|
||||
=========================
|
||||
|
||||
.. automodule:: core.gui.deletion_options
|
||||
:members:
|
||||
10
help/en/_sources/developer/core/gui/index.rst.txt
Normal file
10
help/en/_sources/developer/core/gui/index.rst.txt
Normal file
@@ -0,0 +1,10 @@
|
||||
core.gui
|
||||
========
|
||||
|
||||
.. automodule:: core.gui
|
||||
:members:
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
deletion_options
|
||||
12
help/en/_sources/developer/core/index.rst.txt
Normal file
12
help/en/_sources/developer/core/index.rst.txt
Normal file
@@ -0,0 +1,12 @@
|
||||
core
|
||||
====
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
app
|
||||
fs
|
||||
engine
|
||||
directories
|
||||
results
|
||||
gui/index
|
||||
5
help/en/_sources/developer/core/results.rst.txt
Normal file
5
help/en/_sources/developer/core/results.rst.txt
Normal file
@@ -0,0 +1,5 @@
|
||||
core.results
|
||||
============
|
||||
|
||||
.. automodule:: core.results
|
||||
:members:
|
||||
Reference in New Issue
Block a user