984e0c4094
Fix help path for local files and some help doc updates
2022-03-19 17:43:11 -05:00
3da9d5d869
Update documentation files, add multi-language doc build
...
- Update links in documentation, and some errors
- Remove non-existent page
- Update build to build all languages with --alldoc flag
- Fix one minor debugging change introduced in package.py
2021-08-28 17:07:18 -05:00
Virgil Dupras
30a278719b
Moved credits to the root folder
...
It was a real pain to edit credits files in all languages.
2016-08-16 20:18:49 -04:00
Virgil Dupras
668821301c
Update documentation
2016-06-06 20:48:26 -04:00
Virgil Dupras
abb1345c49
Update FAQ
2015-12-26 09:20:07 -05:00
Virgil Dupras
6930e092e0
Document branching in the repo
2015-07-20 13:02:14 -04:00
Virgil Dupras
3b6fe992c0
Clarify documentation about results filtering
...
It wasn't clear that filtering was applied to whole paths.
ref #294
2015-04-05 16:19:03 -04:00
Virgil Dupras
5b3d5f5d1c
Tweaked the main dev help page to have actual reflinks
2014-10-05 20:12:38 -04:00
Virgil Dupras
44266273bf
Included hscommon.jobprogress in the devdocs
2014-10-05 17:12:10 -04:00
Virgil Dupras
6725b2bf0f
Updated German localisation, by Frank Weber
2014-09-28 13:40:09 -04:00
Virgil Dupras
640561a534
Updated F.A.Q.
...
Fixes #252
2014-03-30 13:43:29 -04:00
Virgil Dupras
4a2fa7cd2c
Updated FAQ
2014-01-10 15:05:45 -05:00
Virgil Dupras
8497343d7f
Updated FAQ in docs
2014-01-05 21:45:57 -05:00
Virgil Dupras
235a2c2904
Added a "contribute" page to the docs.
2014-01-05 21:44:56 -05:00
Virgil Dupras
cb8bb5a70e
Disable symlink/hardlink option when not relevant (Qt)
...
When the "Replace with links" option is not enabled, the choice of
symlink or hardlink is irrelevant and causes confusion. Implemented core
mechanism for controlling the enabled state of that option. Also
implemented the Qt interface for it. Cocoa-part is still to be done.
I used this opportunity to greatly enhance documentation of this part of
the code. I'm beginning to like documenting...
Ref #247 .
2013-12-06 15:48:01 -05:00
Virgil Dupras
7116674663
Improved hscommon docs
2013-11-30 16:13:12 -05:00
Virgil Dupras
5a275db67d
Improved hscommon doc
...
* Completed hscommon.gui.table's doc
* Use sphinx.ext.autosummary.
* Moved attribute docstrings directly into properties.
2013-11-30 12:15:03 -05:00
Virgil Dupras
3734bd6f6c
Improved hscommon.gui docs
...
Added docs for Table and Row in hscommon.gui.table.
2013-11-28 22:38:07 -05:00
Virgil Dupras
da06ef8cad
Improved hscommon.gui docs
2013-11-24 13:53:52 -05:00
Virgil Dupras
398ac9b7c6
Greatly improved docs
...
Added a new scan.rst page, laying out in much more details than before
the inner workings of the scanning process.
Fixes #208 , but does much more than that.
2013-11-17 12:03:48 -05:00
Virgil Dupras
508e9a5d94
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.
2013-11-16 14:46:34 -05:00
Virgil Dupras
78c3c8ec2d
Improved dev docs
2013-08-20 22:52:43 -04:00
Virgil Dupras
7e8f9036d8
Began serious code documentation effort
...
Enabled the autodoc Sphinx extension and started adding docstrings to
classes, methods, etc.. It's quickly becoming quite interesting...
2013-08-18 18:36:09 -04:00
Virgil Dupras
38acb6f91c
Updated french doc
2013-08-17 10:41:41 -04:00
Virgil Dupras
9bcb28d5e2
Fixed inaccuracies in docs
2013-08-16 18:06:58 -04:00
Virgil Dupras
b9124a497c
Added Phan Anh to the credits for the vietnamese loc
2013-08-04 10:19:05 -04:00
Virgil Dupras
b11b97dd7c
Improved delta values to support non-numerical values
...
Delta values now work for non-numerical values. Any column,
when its value differs from its ref, becomes orange.
A column that was already a "delta column" keeps its previous
behavior (dupe cells for these columns are always displayed in
orange).
Sorting behavior, when Dupes Only and Delta Values are enabled
at the same time, has also been extended to non-numerical
values, making it easy to mass-mark dupe rows with orange
values.
Documentation was updated, unit tests were added.
Fixes #213
2013-07-28 17:45:23 -04:00
Virgil Dupras
3edba28f0b
Docs: Added a Developer Guide page
2013-07-28 15:09:17 -04:00
Virgil Dupras
375963ebfd
Docs: Updated F.A.Q
2013-07-28 11:29:36 -04:00
Virgil Dupras
bdd5f0a515
Updated help about symlinks and hardlinks
...
It now mentions that Windows is supported and under which
conditions it is. Ref #220 .
2013-07-14 14:06:01 -04:00
Virgil Dupras
11450ae56a
[ #222 ] Tweaked ref-swapping action text.
...
Make Selected Reference --> Make Selected into Reference.
2013-04-27 09:38:08 -04:00
Virgil Dupras
5b4de58c38
Oops, I had forgot one of the credits file.
2012-08-08 16:53:08 -04:00
Virgil Dupras
09b91aab66
Updated docs to explain the difference between hardlinks and symlinks.
2012-08-02 11:36:31 -04:00
Virgil Dupras
16e4a5fddd
Brazilian localization by Victor Figueiredo.
2012-07-03 12:42:23 -04:00
Virgil Dupras
70cc48d51f
Updated help file to include iPhoto/Aperture/iTunes explanations.
2012-06-06 11:41:14 -04:00
Virgil Dupras
6c62c2d563
Updated help.
2012-06-01 10:23:37 -04:00
Virgil Dupras
cbf2ab82ce
Added Nickolas Pohilets to credits.
2012-05-28 14:54:30 -04:00
Virgil Dupras
720d2fce83
Added Move and iPhoto/iTunes warning in help file.
2012-03-17 10:59:50 -04:00
Virgil Dupras
f813673d6c
Moved help changelog and conf tmpl files to the root of the help folder instead of having one copy per language.
...
--HG--
rename : help/en/changelog.tmpl => help/changelog.tmpl
rename : help/en/conf.tmpl => help/conf.tmpl
2012-01-24 08:28:23 -05:00
Virgil Dupras
757f8569e6
Added "crash" terminology notice in changelog.
2012-01-23 14:38:15 -05:00
Virgil Dupras
e519e41e42
Ukrainian help file by Yuri Petrashko.
2012-01-17 20:51:16 -05:00
Virgil Dupras
c937f2b20f
Ukrainian localization by Yuri Petrashko.
2012-01-17 20:15:09 -05:00
Virgil Dupras
80043ccbea
Added link to russian help document in english help index page.
2012-01-06 12:25:32 -05:00
Virgil Dupras
5b0d9f311c
Added Russian localization for the help file by Igor Pavlov.
2012-01-03 15:35:17 -05:00
Virgil Dupras
08813ce39c
Added Armenian help file translation by Hrant Ohanyan.
2011-12-19 16:02:47 -05:00
Virgil Dupras
565c58b3a9
Updated demo limitations FAQ entry.
2011-11-29 09:41:57 -05:00
Virgil Dupras
0b1bf79796
Updated credits for localizations and added polib to the list of dependencies.
2011-11-25 15:10:18 -05:00
Virgil Dupras
edac54c5e6
[ #138 ] Added reprioritization help section.
2011-09-19 12:12:22 -04:00
Virgil Dupras
14aba2b507
Added Eric Dee to credits for the chinese localization.
2011-09-03 10:25:17 -04:00
Virgil Dupras
df57d993f6
Updated credits (to add gregor for the german loc).
2011-08-22 16:30:54 -04:00
