Bug 404613 - Docs are missing
Summary: Docs are missing
Status: RESOLVED FIXED
Alias: None
Product: digikam
Classification: Applications
Component: Documentation (show other bugs)
Version: 6.0.0
Platform: Other Linux
: NOR normal
Target Milestone: ---
Assignee: Digikam Developers
URL:
Keywords:
Depends on:
Blocks:
 
Reported: 2019-02-20 18:12 UTC by Wolfgang Bauer
Modified: 2022-12-24 11:24 UTC (History)
1 user (show)

See Also:
Latest Commit:
Version Fixed In: 8.0.0
Sentry Crash Report:


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Wolfgang Bauer 2019-02-20 18:12:06 UTC
When trying to package digikam 6.0.0, I noticed that the doc folder is missing.
And cmake reports:
-- Main one documentation directory is missing. Compilation of documentation is disabled...

I don't know whether this is a mistake or intentional, so I decided to report it.
Feel free to just close this in the latter case.

But, the doc-translated folder is still there (but not built anymore), it probably should be removed then as well?
Comment 1 Wolfgang Bauer 2019-02-20 18:18:58 UTC
(In reply to Wolfgang Bauer from comment #0)
> When trying to package digikam 6.0.0, I noticed that the doc folder is
> missing.

In the released source tarball, that is...
Comment 2 Christoph Feck 2019-02-20 22:34:02 UTC
https://cgit.kde.org/digikam says there is a separate repository for the documentation.
Comment 3 caulier.gilles 2019-02-21 08:01:10 UTC
yes the documentation still a in a separated repository, because it's huge.

Typically, the source code tarball must have only the GUI translations, not the documentation translations.

In all cases, the documentation can be displayed online here :

https://www.digikam.org/documentation/

Gilles Caulier
Comment 4 caulier.gilles 2020-08-04 16:47:41 UTC
The documentation can be downloaded automatically when you configure the tarball :

https://invent.kde.org/graphics/digikam/-/blob/master/CMakeLists.txt#L116

2 options are available : one to checkout doc code, one to checkout doc translations.

Both options are disable by default for the explanation given in comment #3

Gilles Caulier
Comment 5 caulier.gilles 2022-12-24 11:24:09 UTC
The next generation of digiKam documentation based on Sphinx/RestructuredText
will be available online only.

An HTML version will be updated daily, including an EPUB version.

https://docs.digikam.org/en/index.html

Gilles Caulier