[Qt-creator] How to build Qt Creator documentation from the sources

[Szyk Cech]

Hi!
I try generate documentation from cloned Qt Creator sources, but I
failed for this! It displays some stupid error messages! Like this:

Because I got error earlier, I remove first commented line, but it not
help:

Switch view

1.
/!-ściągnięte/qt-creator/doc$ qdoc -outputdir ../doc-ready
-installdir ../doc-installed ./qtcreator.qdocconf -single-exec
2.
qdoc: error: Cannot open file
'include(config/qtcreator-project.qdocconf)': No such file or directory
3.
Cannot open file 'include(config/qtcreator-project.qdocconf)': No
such file or directory
4.
5.
Aborting

/To copy to clipboard, switch view to plain text mode /
But I my next command:
Qt Code:
Switch view

1.
/!-ściągnięte/qt-creator/doc$ ls -l ./config/qtcreator-project.qdocconf
2.
-rw-rw-r-- 1 szyk szyk 2695 sie 1 22:50
./config/qtcreator-project.qdocconf

/To copy to clipboard, switch view to plain text mode /
So it seems qdoc produce nonsense error because file exists!
This is very anoying!!!
Please help me.

Thanks in advance and best regards
Szyk Cech

[Robert Löhning]

Post by Szyk Cech
Hi!
I try generate documentation from cloned Qt Creator sources, but I
Because I got error earlier, I remove first commented line, but it not
Switch view
1.
   /!-ściągnięte/qt-creator/doc$ qdoc -outputdir ../doc-ready
   -installdir ../doc-installed ./qtcreator.qdocconf -single-exec
2.
   qdoc: error: Cannot open file
   'include(config/qtcreator-project.qdocconf)': No such file or directory
3.
   Cannot open file 'include(config/qtcreator-project.qdocconf)': No
   such file or directory
4.
5.
   Aborting
/To copy to clipboard, switch view to plain text mode /
Switch view
1.
   /!-ściągnięte/qt-creator/doc$ ls -l ./config/qtcreator-project.qdocconf
2.
   -rw-rw-r-- 1 szyk szyk 2695 sie 1 22:50
   ./config/qtcreator-project.qdocconf
/To copy to clipboard, switch view to plain text mode /
So it seems qdoc produce nonsense error because file exists!
This is very anoying!!!
Please help me.
Thanks in advance and best regards
Szyk Cech

Hi,

normally, calling

make qch_docs

in Creator's build directory should build the documentation for you.
Would you like to share the commands you ran with us?

Is "!-ściągnięte" a directory you're building Creator in? I'm not sure
whether this is supported. Does the problem persist if you build in a
directory with a name made of good old ASCII characters?

Cheers,
Robert

[Szyk Cech]

Hi again

Sorry for double post, but I forgot mention what I want from this
documentation:

I want study Qt Creator plugin architecture. Now I know it has almost
everything as plugin. But I want to know how are created interfaces
between plugins in order to communicate and keep architecture modular.
To me it is not trivial task to design such architecture. I want write
my new text editor in similar fashion like Qt Creator because I consider
it as right and mature solution.

Another related question:

Can you advice me what another projects are suitable to study for plugin
oriented architecture? Or what other lectures (books, articles,
tutorials) are essential in this subject?!? I ask you because my
strategic goal is to be professional programmer able to design bigger
projects in modular and easy extendable way. So your help will be
appreciated!

Thanks in advance and best regards
Szyk Cech

Post by Szyk Cech
Hi!
I try generate documentation from cloned Qt Creator sources, but I
Because I got error earlier, I remove first commented line, but it not
Switch view
1.
/!-ściągnięte/qt-creator/doc$ qdoc -outputdir ../doc-ready
-installdir ../doc-installed ./qtcreator.qdocconf -single-exec
2.
qdoc: error: Cannot open file
'include(config/qtcreator-project.qdocconf)': No such file or directory
3.
Cannot open file 'include(config/qtcreator-project.qdocconf)': No
such file or directory
4.
5.
Aborting
/To copy to clipboard, switch view to plain text mode /
Switch view
1.
/!-ściągnięte/qt-creator/doc$ ls -l
./config/qtcreator-project.qdocconf
2.
-rw-rw-r-- 1 szyk szyk 2695 sie 1 22:50
./config/qtcreator-project.qdocconf
/To copy to clipboard, switch view to plain text mode /
So it seems qdoc produce nonsense error because file exists!
This is very anoying!!!
Please help me.
Thanks in advance and best regards
Szyk Cech
_______________________________________________
Qt-creator mailing list
http://lists.qt-project.org/mailman/listinfo/qt-creator

[Artur Shepilko]

I normally do:

cd build-qtcreator
make docs
ls share/doc/qtcreator/qtcreator.qch

This expects Qt doc files properly installed. In older Qt versions
there was a missing link to global .qdocconf, so it'd show an error
and would require one to manually create the missing link. In recent
versions it builds all the way as is. It does show a while bunch of
warnings though, but I guess it's "by design".

This may be helpful
[https://doc-snapshots.qt.io/qtcreator-extending/qtcreator-documentation.html]

[Szyk Cech]

Thanks! Now it works.

One more question:

/home/szyk/!-ściągnięte/build-qtcreator-Desktop_Qt_5_9_6_GCC_64bit-Release/share/doc/qtcreator/qtcreator-dev.qch

Is suppose to expose only one document in table of content named:
"Extending Qt Creator Manual"?!?

Post by Artur Shepilko
cd build-qtcreator
make docs
ls share/doc/qtcreator/qtcreator.qch
This expects Qt doc files properly installed. In older Qt versions
there was a missing link to global .qdocconf, so it'd show an error
and would require one to manually create the missing link. In recent
versions it builds all the way as is. It does show a while bunch of
warnings though, but I guess it's "by design".
This may be helpful
[https://doc-snapshots.qt.io/qtcreator-extending/qtcreator-documentation.html]
_______________________________________________
Qt-creator mailing list
http://lists.qt-project.org/mailman/listinfo/qt-creator

[Artur Shepilko]

Post by Szyk Cech
/home/szyk/!-ściągnięte/build-qtcreator-Desktop_Qt_5_9_6_GCC_64bit-Release/share/doc/qtcreator/qtcreator-dev.qch
Is suppose to expose only one document in table of content named: "Extending
Qt Creator Manual"?!?

I'm not sure what docs you're updating, but as long as they fit into
the existing qtcreator doc hierarchy, the changes will be picked up
and included in the resulting .qch files with updated links and TOC:

ls share/doc/qtcreator/

[Szyk Cech]

I added qtcreator-dev.qch  qtcreator.qch manually to the Qt Assistant.
And nothing found except "Extending Qt Creator Manual" chapter. IMO it
is little for over 8MB compressed documentation files... So please
answer to my question... Is there something I missed? or: Is this
chapter cover every topics related to the Qt Creator code documentation?

Post by Artur Shepilko

Post by Szyk Cech
/home/szyk/!-ściągnięte/build-qtcreator-Desktop_Qt_5_9_6_GCC_64bit-Release/share/doc/qtcreator/qtcreator-dev.qch
Is suppose to expose only one document in table of content named: "Extending
Qt Creator Manual"?!?

I'm not sure what docs you're updating, but as long as they fit into
the existing qtcreator doc hierarchy, the changes will be picked up
ls share/doc/qtcreator/
_______________________________________________
Qt-creator mailing list
http://lists.qt-project.org/mailman/listinfo/qt-creator

[Eike Ziller]

I added qtcreator-dev.qch qtcreator.qch manually to the Qt Assistant. And nothing found except "Extending Qt Creator Manual" chapter. IMO it is little for over 8MB compressed documentation files... So please answer to my question... Is there something I missed? or: Is this chapter cover every topics related to the Qt Creator code documentation?

You can have a look at the online copy of the generated “developer” documentation here:
https://doc-snapshots.qt.io/qtcreator-extending/extending-index.html

“Extending Qt Creator Manual” is the top-level heading for that documentation, yes.
The code documentation that we have is not very extensive.

There is a bit of documentation on the plugin mechanism in general, like what the plugin meta data consists of for specifying version numbers, dependencies, optional dependencies etc:
https://doc-snapshots.qt.io/qtcreator-extending/plugin-meta-data.html
and about the plugin life cycle (startup, shutdown) https://doc-snapshots.qt.io/qtcreator-extending/plugin-lifecycle.html

There is also some generated API documentation at https://doc-snapshots.qt.io/qtcreator-extending/qtcreator-api.html
but there are only few classes with an actual useful amount of documentation.

Br, Eike

Post by Artur Shepilko

Post by Szyk Cech
/home/szyk/!-ściągnięte/build-qtcreator-Desktop_Qt_5_9_6_GCC_64bit-Release/share/doc/qtcreator/qtcreator-dev.qch
Is suppose to expose only one document in table of content named: "Extending
Qt Creator Manual"?!?

I'm not sure what docs you're updating, but as long as they fit into
the existing qtcreator doc hierarchy, the changes will be picked up
ls share/doc/qtcreator/
_______________________________________________
Qt-creator mailing list
http://lists.qt-project.org/mailman/listinfo/qt-creator

_______________________________________________
Qt-creator mailing list
http://lists.qt-project.org/mailman/listinfo/qt-creator

--
Eike Ziller
Principal Software Engineer

The Qt Company GmbH
Rudower Chaussee 13
D-12489 Berlin
***@qt.io
http://qt.io
Geschäftsführer: Mika Pälsi,
Juha Varelius, Mika Harjuaho
Sitz der Gesellschaft: Berlin, Registergericht: Amtsgericht Charlottenburg, HRB 144331 B