New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Moved MainPage.h #576

Merged
merged 2 commits into from Jan 20, 2016

Conversation

Projects
None yet
4 participants
@AnotherFoxGuy
Member

AnotherFoxGuy commented Jan 14, 2016

Moved the MainPage file to its correct place 馃槂
Also fixed some links in the file

@only-a-ptr

This comment has been minimized.

Show comment
Hide comment
@only-a-ptr

only-a-ptr Jan 15, 2016

Member

That's how I like it 馃槃
However, does doxygen find the MainPage.h now? It seems to be configured to look only in source/main

Member

only-a-ptr commented Jan 15, 2016

That's how I like it 馃槃
However, does doxygen find the MainPage.h now? It seems to be configured to look only in source/main

@only-a-ptr

This comment has been minimized.

Show comment
Hide comment
@only-a-ptr

only-a-ptr Jan 18, 2016

Member

@AnotherFoxGuy Did you test this? Are you sure Doxygen finds the MainPage.h in the /docs directory? There doesn't seem to be any link leading there.

Member

only-a-ptr commented Jan 18, 2016

@AnotherFoxGuy Did you test this? Are you sure Doxygen finds the MainPage.h in the /docs directory? There doesn't seem to be any link leading there.

@AnotherFoxGuy

This comment has been minimized.

Show comment
Hide comment
@AnotherFoxGuy

AnotherFoxGuy Jan 19, 2016

Member

I don't use the default Doxygen file, but you can set multiple directories in the advanced tab
doxywizard_2016-01-19_12-03-40

Member

AnotherFoxGuy commented Jan 19, 2016

I don't use the default Doxygen file, but you can set multiple directories in the advanced tab
doxywizard_2016-01-19_12-03-40

@only-a-ptr

This comment has been minimized.

Show comment
Hide comment
@only-a-ptr

only-a-ptr Jan 19, 2016

Member

@AnotherFoxGuy I'd prefer to have a script which auto-generates doxy-docs without any manual configuration.

I like the orange-themed docs you're publishing. If you're not using any of the scripts in the docs/ directory, feel free to delete them and supply a configuration file you're using yourself, please. In case you don't use a script and do everything manually every time, please create a script for it and commit it.

Member

only-a-ptr commented Jan 19, 2016

@AnotherFoxGuy I'd prefer to have a script which auto-generates doxy-docs without any manual configuration.

I like the orange-themed docs you're publishing. If you're not using any of the scripts in the docs/ directory, feel free to delete them and supply a configuration file you're using yourself, please. In case you don't use a script and do everything manually every time, please create a script for it and commit it.

@mikadou

This comment has been minimized.

Show comment
Hide comment
@mikadou

mikadou Jan 19, 2016

Contributor

Some time ago I implemented a custom target in the CMake build system which allows to build documentation: mikadou@ee59c37

I can add it, when I'm finished with polishing the rest of the build system.

And as a bonus, it is also possible to automatically rebuild documentation with each commit done to the central repository. See http://mikadou.github.io/rigs-of-rods/ for auto-generated docs. Yes they are out of date, since it was a proof-of-concept only. To get this running on the official repo however requires somebody to set up Travis accordingly, since I don't have the permissions to do it.

The provided Doxygen config file has some cool features enabled, e.g.:
http://mikadou.github.io/rigs-of-rods/structbeam__t__coll__graph_org.svg

Contributor

mikadou commented Jan 19, 2016

Some time ago I implemented a custom target in the CMake build system which allows to build documentation: mikadou@ee59c37

I can add it, when I'm finished with polishing the rest of the build system.

And as a bonus, it is also possible to automatically rebuild documentation with each commit done to the central repository. See http://mikadou.github.io/rigs-of-rods/ for auto-generated docs. Yes they are out of date, since it was a proof-of-concept only. To get this running on the official repo however requires somebody to set up Travis accordingly, since I don't have the permissions to do it.

The provided Doxygen config file has some cool features enabled, e.g.:
http://mikadou.github.io/rigs-of-rods/structbeam__t__coll__graph_org.svg

@only-a-ptr

This comment has been minimized.

Show comment
Hide comment
@only-a-ptr

only-a-ptr Jan 19, 2016

Member

@mikadou 馃憤
Do contribute the Doxy script please. I'll ask Hiradur to update Travis (I don't know how 馃槉 )

Member

only-a-ptr commented Jan 19, 2016

@mikadou 馃憤
Do contribute the Doxy script please. I'll ask Hiradur to update Travis (I don't know how 馃槉 )

@Hiradur

This comment has been minimized.

Show comment
Hide comment
@Hiradur

Hiradur Jan 20, 2016

Contributor

One question is where should these be deployed? To http://rigsofrods.github.io?

Contributor

Hiradur commented Jan 20, 2016

One question is where should these be deployed? To http://rigsofrods.github.io?

@mikadou

This comment has been minimized.

Show comment
Hide comment
@mikadou

mikadou Jan 20, 2016

Contributor

I'd say it makes sense to put the docs on the projects github pages, doesn't it?

Contributor

mikadou commented Jan 20, 2016

I'd say it makes sense to put the docs on the projects github pages, doesn't it?

@only-a-ptr

This comment has been minimized.

Show comment
Hide comment
@only-a-ptr

only-a-ptr Jan 20, 2016

Member

I'd say it makes sense to put the docs on the projects github pages, doesn't it?

Yes it does 馃槃 But so far nobody bothered to set it up.

Member

only-a-ptr commented Jan 20, 2016

I'd say it makes sense to put the docs on the projects github pages, doesn't it?

Yes it does 馃槃 But so far nobody bothered to set it up.

@Hiradur

This comment has been minimized.

Show comment
Hide comment
@Hiradur

Hiradur Jan 20, 2016

Contributor

I think it would be best if we give you some permissions and you can experiment with this on your own. Travis is already a hassle to set up due to the non-interactiveness and adding another instance like me doesn't help.

Contributor

Hiradur commented Jan 20, 2016

I think it would be best if we give you some permissions and you can experiment with this on your own. Travis is already a hassle to set up due to the non-interactiveness and adding another instance like me doesn't help.

@only-a-ptr

This comment has been minimized.

Show comment
Hide comment
@only-a-ptr

only-a-ptr Jan 20, 2016

Member

@Hiradur I didn't mean to be pinchy towards you, by 'nobody' I meant primarily myself.

By 'give you some permissions', you mean me or @mikadou? I'd be fine with Mikadou having the access

Member

only-a-ptr commented Jan 20, 2016

@Hiradur I didn't mean to be pinchy towards you, by 'nobody' I meant primarily myself.

By 'give you some permissions', you mean me or @mikadou? I'd be fine with Mikadou having the access

@Hiradur

This comment has been minimized.

Show comment
Hide comment
@Hiradur

Hiradur Jan 20, 2016

Contributor

I didn't mean to be pinchy towards you, by 'nobody' I meant primarily myself.

I didn't understand it that way. I guess we were all a bit lazy since we already had access to AnotherFoxGuy's docs.

By 'give you some permissions', you mean me or @mikadou?

I meant @mikadou , sorry if it was unclear.

Contributor

Hiradur commented Jan 20, 2016

I didn't mean to be pinchy towards you, by 'nobody' I meant primarily myself.

I didn't understand it that way. I guess we were all a bit lazy since we already had access to AnotherFoxGuy's docs.

By 'give you some permissions', you mean me or @mikadou?

I meant @mikadou , sorry if it was unclear.

@mikadou

This comment has been minimized.

Show comment
Hide comment
@mikadou

mikadou Jan 20, 2016

Contributor

Just created a new PR, therein the new MainPage.h location is already considered: #621
Therefore this PR can be applied afterwards.

@AnotherFoxGuy BTW sorry for hijacking your pull request 馃槒

Contributor

mikadou commented Jan 20, 2016

Just created a new PR, therein the new MainPage.h location is already considered: #621
Therefore this PR can be applied afterwards.

@AnotherFoxGuy BTW sorry for hijacking your pull request 馃槒

only-a-ptr added a commit that referenced this pull request Jan 20, 2016

Merge pull request #576 from AnotherFoxGuy/master
[doc] Moved MainPage.h (doxygen-only header)

@only-a-ptr only-a-ptr merged commit 43a6360 into RigsOfRods:master Jan 20, 2016

1 check passed

continuous-integration/travis-ci/pr The Travis CI build passed
Details
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment