Thread: [Doxygen-users] Looking for beta testers of a Doxygen GitHub integration
Brought to you by:
dimitri
Menu
▾
▴
doxygen-users
|
From: Paul N. <pa...@pa...> - 2016-01-06 02:15:12
|
Hello, I put together a GitHub integration for generating and hosting Doxygen docs for your public GitHub repositories. Consider this an early prototype, but I would like to get some testers and feedback. Just go to: https://codedocs.xyz/ You should see a list of your public repositories. Then enable the repositories you want Doxygen generated for. A GitHub hook is added, so the documentation is rebuilt every time you push changes to GitHub. You can add badges to your README.md (like Coverity, Travis-CI, etc) that point to the documentation that is hosted on codedocs.xyz. For example, look at my OpenSceneGraph and Doxygen forks: https://github.com/paulnovo/osg https://github.com/paulnovo/doxygen I added the "code: documented" badges to the README.md that point to the latest Doxgyen documentation: https://codedocs.xyz/paulnovo/osg/ https://codedocs.xyz/paulnovo/doxygen/ Let me know what you think. Hopefully this will be useful for Doxygen users. -Paul |
|
From: Allen W. <wi...@kd...> - 2016-01-07 00:12:44
|
On Tuesday, January 05, 2016 08:56:26 PM Paul Novotny wrote: > Hello, > > I put together a GitHub integration for generating and hosting Doxygen > docs for your public GitHub repositories. Consider this an early > prototype, but I would like to get some testers and feedback. Just go > to: > > https://codedocs.xyz/ > Most awesome idea. I successfully created apidox from one of my forks. I have a lot of ideas and thoughts. Here are a few: 1) some of my repos are under my github login I'd like to be able to create codedocs for my other projects that are not under my login. For example: https://github.com/libical/libical 2) I wonder if you could look for an existing Doxyfile at the top-level instead of looking at .codedocs. one of my projects has a docs/Doxyfile 3) could we start collect project tags files and somehow automatically (or at least by Doxyfile) start linking together the dox of all projects from one convenient location :) This is most wonderful idea and I'm happy to continue testing. -Allen > You should see a list of your public repositories. Then enable the > repositories you want Doxygen generated for. A GitHub hook is added, so > the documentation is rebuilt every time you push changes to GitHub. You > can add badges to your README.md (like Coverity, Travis-CI, etc) that > point to the documentation that is hosted on codedocs.xyz. For example, > look at my OpenSceneGraph and Doxygen forks: > > https://github.com/paulnovo/osg > https://github.com/paulnovo/doxygen > > I added the "code: documented" badges to the README.md that point to the > latest Doxgyen documentation: > > https://codedocs.xyz/paulnovo/osg/ > https://codedocs.xyz/paulnovo/doxygen/ > > Let me know what you think. Hopefully this will be useful for Doxygen > users. > > -Paul > > ------------------------------------------------------------------------------ > _______________________________________________ > Doxygen-users mailing list > Dox...@li... > https://lists.sourceforge.net/lists/listinfo/doxygen-users |
|
From: Peter B. <pd...@ma...> - 2016-01-07 00:17:51
|
+1. Ours is at doc/doxygen.conf It looks like the .codedocs file is intended to be a minimal Doxygen configuration. What about adding a (non-Doxygen) keyword to point to the project-specific Doxygen configuration file? P > On Jan 6, 2016, at 3:51 PM, Allen Winter <wi...@kd...> wrote: > > 2) I wonder if you could look for an existing Doxyfile at the top-level > instead of looking at .codedocs. one of my projects has a docs/Doxyfile ____________ Peter Barnes pd...@ma... <mailto:pd...@ma...> |
|
From: Paul N. <pa...@pa...> - 2016-01-07 03:48:59
|
Allen and Peter, thanks for trying it out. Yes, at the moment, the .codedocs is a minimal set of Doxygen configuration settings. Partly because I am hesitant to allow them all without looking into them first and making sure they work (ie, I have the environment setup correctly for them to work). So please suggest options you would like and I will enable them. Creating an option to point to the location of the doxygen config file is a good idea. I still would have to parse the pointed to doxygen config file to make sure there aren't any issues, ie having an unchecked INPUT setting is not a great idea. -Paul On Wed, Jan 6, 2016, at 07:17 PM, Peter Barnes wrote: > +1. Ours is at doc/doxygen.conf > > It looks like the .codedocs file is intended to be a minimal Doxygen configuration. What about adding a (non-Doxygen) keyword to point to the project-specific Doxygen configuration file? > > P > >> On Jan 6, 2016, at 3:51 PM, Allen Winter <wi...@kd...> wrote: >> >> 2) I wonder if you could look for an existing Doxyfile at the top-level >> instead of looking at .codedocs. one of my projects has a docs/Doxyfile > > ____________ > Peter Barnes > pd...@ma... > ------------------------------------------------------------------------------ > _________________________________________________ > Doxygen-users mailing list > Dox...@li... > https://lists.sourceforge.net/lists/listinfo/doxygen-users |
|
From: Paul N. <pa...@pa...> - 2016-01-07 03:59:19
|
On Wed, Jan 6, 2016, at 06:51 PM, Allen Winter wrote: > I have a lot of ideas and thoughts. > Here are a few: > 1) some of my repos are under my github login I'd like to be able > to create codedocs for my other projects that are not under my login. > For example: https://github.com/libical/libical Currently, you could do this by forking these repositories. But I also would like some way to have the Doxgyen docs for repos that aren't mine. Like OpenSceneGraph. I'll think about this a bit. > 2) I wonder if you could look for an existing Doxyfile at the top-level > instead of looking at .codedocs. one of my projects has a docs/Doxyfile See my previous email in response to Peter. I think his idea of putting in a config file that points to the Doxyfile location is probably the way to handle this. > 3) could we start collect project tags files and somehow automatically > (or at least by Doxyfile) start linking together the dox of all projects > from one convenient location :) Oh boy! The master-dox. > This is most wonderful idea and I'm happy to continue testing. Thank you! -Paul |
|
From: Allen W. <wi...@kd...> - 2016-01-07 16:49:49
|
On Wednesday, January 06, 2016 10:59:07 PM Paul Novotny wrote: > On Wed, Jan 6, 2016, at 06:51 PM, Allen Winter wrote: > > I have a lot of ideas and thoughts. > > Here are a few: > > 1) some of my repos are under my github login I'd like to be able > > to create codedocs for my other projects that are not under my login. > > For example: https://github.com/libical/libical > > Currently, you could do this by forking these repositories. But I also > would like some way to have the Doxgyen docs for repos that aren't mine. > Like OpenSceneGraph. I'll think about this a bit. > see travis-ci.org which allows me to choose repos from any organization I belong to. |
|
From: Paul N. <pa...@pa...> - 2016-01-07 17:32:21
|
On Thu, 2016-01-07 at 11:49 -0500, Allen Winter wrote: > On Wednesday, January 06, 2016 10:59:07 PM Paul Novotny wrote: > > On Wed, Jan 6, 2016, at 06:51 PM, Allen Winter wrote: > > > I have a lot of ideas and thoughts. > > > Here are a few: > > > 1) some of my repos are under my github login I'd like to be able > > > to create codedocs for my other projects that are not under my > > > login. > > > For example: https://github.com/libical/libical > > > > Currently, you could do this by forking these repositories. But I > > also > > would like some way to have the Doxgyen docs for repos that aren't > > mine. > > Like OpenSceneGraph. I'll think about this a bit. > > > see travis-ci.org which allows me to choose repos from any > organization I belong to. Oh, I misunderstood your question. Yes, there is no support for repositories in organizations you belong to, but it is what I am working on now. So stay tuned. -Paul |
|
From: Baptiste W. <bap...@gm...> - 2016-01-07 08:47:41
|
On Tue, Jan 05, 2016 at 08:56:26PM -0500, Paul Novotny wrote: > Hello, > > I put together a GitHub integration for generating and hosting Doxygen > docs for your public GitHub repositories. Consider this an early > prototype, but I would like to get some testers and feedback. Just go > to: > > https://codedocs.xyz/ > > You should see a list of your public repositories. Then enable the > repositories you want Doxygen generated for. A GitHub hook is added, so > the documentation is rebuilt every time you push changes to GitHub. You > can add badges to your README.md (like Coverity, Travis-CI, etc) that > point to the documentation that is hosted on codedocs.xyz. For example, > look at my OpenSceneGraph and Doxygen forks: > > .... > > Let me know what you think. Hopefully this will be useful for Doxygen > users. > > -Paul Hi Paul, This is an excellent idea :) I may be doing something wrong, but when I go on the site, only some of my repositories are displayed, it seems the first X in alphabetical order. Is there a limit ? The projects I wanted to tests are not displayed. Thanks Baptiste Wicht |
|
From: Paul N. <pa...@pa...> - 2016-01-07 14:25:34
|
On Thu, 2016-01-07 at 09:47 +0100, Baptiste Wicht wrote: > Hi Paul, > > This is an excellent idea :) > > I may be doing something wrong, but when I go on the site, only some > of > my repositories are displayed, it seems the first X in alphabetical > order. Is there a limit ? > > The projects I wanted to tests are not displayed. 112 repositories, wow, you are a good tester. :-) It looks like github is sending me repositories in bunches, but I never knew that since all the repositories always fit into the first bunch. I should have a fix up shortly. -Paul |
|
From: Sparr <sp...@gm...> - 2016-01-08 00:55:59
|
I want to give this a try, but apparently GitHub won't let me give your app permission to access just one of the organizations I'm part of. That's a deal breaker for me; not that I don't trust your app, but I don't give any access to some organizations. On Tue, Jan 5, 2016 at 5:56 PM, Paul Novotny <pa...@pa...> wrote: > Hello, > > I put together a GitHub integration for generating and hosting Doxygen > docs for your public GitHub repositories. Consider this an early > prototype, but I would like to get some testers and feedback. Just go > to: > > https://codedocs.xyz/ > > You should see a list of your public repositories. Then enable the > repositories you want Doxygen generated for. A GitHub hook is added, so > the documentation is rebuilt every time you push changes to GitHub. You > can add badges to your README.md (like Coverity, Travis-CI, etc) that > point to the documentation that is hosted on codedocs.xyz. For example, > look at my OpenSceneGraph and Doxygen forks: > > https://github.com/paulnovo/osg > https://github.com/paulnovo/doxygen > > I added the "code: documented" badges to the README.md that point to the > latest Doxgyen documentation: > > https://codedocs.xyz/paulnovo/osg/ > https://codedocs.xyz/paulnovo/doxygen/ > > Let me know what you think. Hopefully this will be useful for Doxygen > users. > > -Paul > > > ------------------------------------------------------------------------------ > _______________________________________________ > Doxygen-users mailing list > Dox...@li... > https://lists.sourceforge.net/lists/listinfo/doxygen-users > |
|
From: Paul N. <pa...@pa...> - 2016-01-08 01:30:47
|
Unfortunately, organizations are not currently supported by the app. So GitHub should not be asking you for permissions to access your organizations, it should only be asking for access to your email and adding repository hooks to your public repositories. However, I am currently adding support for organizations, and will require access to them. Unfortunatly, their current api does not allow for fine grain control of the permissions. Although it sounds like GitHub is moving in that direction, so this might work for you in the future. -Paul On Thu, Jan 7, 2016, at 07:55 PM, Sparr wrote: > I want to give this a try, but apparently GitHub won't let me give > your app permission to access just one of the organizations I'm part > of. That's a deal breaker for me; not that I don't trust your app, but > I don't give any access to some organizations. > > On Tue, Jan 5, 2016 at 5:56 PM, Paul Novotny <pa...@pa...> wrote: >> Hello, >> >> I put together a GitHub integration for generating and hosting Doxygen >> docs for your public GitHub repositories. Consider this an early >> prototype, but I would like to get some testers and feedback. Just go >> to: >> >> https://codedocs.xyz/ >> >> You should see a list of your public repositories. Then enable the >> repositories you want Doxygen generated for. A GitHub hook is added, so >> the documentation is rebuilt every time you push changes to GitHub. You >> can add badges to your README.md (like Coverity, Travis-CI, etc) that >> point to the documentation that is hosted on codedocs.xyz. For example, >> look at my OpenSceneGraph and Doxygen forks: >> >> https://github.com/paulnovo/osg https://github.com/paulnovo/doxygen >> >> I added the "code: documented" badges to the README.md that point to the >> latest Doxgyen documentation: >> >> https://codedocs.xyz/paulnovo/osg/ >> https://codedocs.xyz/paulnovo/doxygen/ >> >> Let me know what you think. Hopefully this will be useful for Doxygen >> users. >> >> -Paul >> >> -------------------------------------------------------------------- ---------- >> _______________________________________________ >> Doxygen-users mailing list >> Dox...@li... >> https://lists.sourceforge.net/lists/listinfo/doxygen-users |
|
From: Paul N. <pa...@pa...> - 2016-01-09 18:28:04
|
On Thu, Jan 7, 2016, at 09:25 AM, Paul Novotny wrote: > On Thu, 2016-01-07 at 09:47 +0100, Baptiste Wicht wrote: > > Hi Paul, > > > > This is an excellent idea :) > > > > I may be doing something wrong, but when I go on the site, only some > > of > > my repositories are displayed, it seems the first X in alphabetical > > order. Is there a limit ? > > > > The projects I wanted to tests are not displayed. > > 112 repositories, wow, you are a good tester. :-) It looks like github > is sending me repositories in bunches, but I never knew that since all > the repositories always fit into the first bunch. I should have a fix > up shortly. Hi Baptiste, I think I solved the problem, please give it a try and let me know if you see all of your repositories. -Paul |
|
From: Baptiste W. <bap...@gm...> - 2016-01-11 08:28:52
|
On Sat, Jan 09, 2016 at 01:27:56PM -0500, Paul Novotny wrote: > On Thu, Jan 7, 2016, at 09:25 AM, Paul Novotny wrote: > > On Thu, 2016-01-07 at 09:47 +0100, Baptiste Wicht wrote: > > > Hi Paul, > > > > > > This is an excellent idea :) > > > > > > I may be doing something wrong, but when I go on the site, only some > > > of > > > my repositories are displayed, it seems the first X in alphabetical > > > order. Is there a limit ? > > > > > > The projects I wanted to tests are not displayed. > > > > 112 repositories, wow, you are a good tester. :-) It looks like github > > is sending me repositories in bunches, but I never knew that since all > > the repositories always fit into the first bunch. I should have a fix > > up shortly. > > Hi Baptiste, I think I solved the problem, please give it a try and let > me know if you see all of your repositories. > -Paul Hi Paul, Yes, it works fine with my long list of repositories now :) Thanks Baptiste |
|
From: Paul N. <pa...@pa...> - 2016-02-27 15:33:00
|
On Thu, 2016-01-07 at 12:32 -0500, Paul Novotny wrote: > On Thu, 2016-01-07 at 11:49 -0500, Allen Winter wrote: > > On Wednesday, January 06, 2016 10:59:07 PM Paul Novotny wrote: > > > On Wed, Jan 6, 2016, at 06:51 PM, Allen Winter wrote: > > > > I have a lot of ideas and thoughts. > > > > Here are a few: > > > > 1) some of my repos are under my github login I'd like to be able > > > > to create codedocs for my other projects that are not under my > > > > login. > > > > For example: https://github.com/libical/libical > > > > > > Currently, you could do this by forking these repositories. But I > > > also > > > would like some way to have the Doxgyen docs for repos that aren't > > > mine. > > > Like OpenSceneGraph. I'll think about this a bit. > > > > > see travis-ci.org which allows me to choose repos from any > > organization I belong to. > > Oh, I misunderstood your question. Yes, there is no support for > repositories in organizations you belong to, but it is what I am > working on now. So stay tuned. Hi Allen, I added support for public organizations. You should now be able to choose repositories for organizations you belong to. I have been testing it for a bit, but would appreciate more testers. Let me know if this works for you. Thanks, -Paul |
|
From: Allen W. <wi...@kd...> - 2016-02-28 14:57:13
|
On Saturday, February 27, 2016 10:15:50 AM Paul Novotny wrote: > On Thu, 2016-01-07 at 12:32 -0500, Paul Novotny wrote: > > On Thu, 2016-01-07 at 11:49 -0500, Allen Winter wrote: > > > On Wednesday, January 06, 2016 10:59:07 PM Paul Novotny wrote: > > > > On Wed, Jan 6, 2016, at 06:51 PM, Allen Winter wrote: > > > > > I have a lot of ideas and thoughts. > > > > > Here are a few: > > > > > 1) some of my repos are under my github login I'd like to be able > > > > > to create codedocs for my other projects that are not under my > > > > > login. > > > > > For example: https://github.com/libical/libical > > > > > > > > Currently, you could do this by forking these repositories. But I > > > > also > > > > would like some way to have the Doxgyen docs for repos that aren't > > > > mine. > > > > Like OpenSceneGraph. I'll think about this a bit. > > > > > > > see travis-ci.org which allows me to choose repos from any > > > organization I belong to. > > > > Oh, I misunderstood your question. Yes, there is no support for > > repositories in organizations you belong to, but it is what I am > > working on now. So stay tuned. > > Hi Allen, I added support for public organizations. You should now be > able to choose repositories for organizations you belong to. I have been > testing it for a bit, but would appreciate more testers. Let me know if > this works for you. > yep, so far so good. thanks Paul. |
|
From: Allen W. <wi...@kd...> - 2016-06-13 21:27:13
|
Hi Paul, I noticed that images (under a top-level folder called 'images') are not being found. My .codedocs file has: DOXYFILE = Doxyfile and my Doxyfile has: IMAGE_PATH = images similar with examples, I think (and EXAMPLE_PATH) any idea what I'm doing wrong? -Allen On Tuesday, January 05, 2016 08:56:26 PM Paul Novotny wrote: > Hello, > > I put together a GitHub integration for generating and hosting Doxygen > docs for your public GitHub repositories. Consider this an early > prototype, but I would like to get some testers and feedback. Just go > to: > > https://codedocs.xyz/ > > You should see a list of your public repositories. Then enable the > repositories you want Doxygen generated for. A GitHub hook is added, so > the documentation is rebuilt every time you push changes to GitHub. You > can add badges to your README.md (like Coverity, Travis-CI, etc) that > point to the documentation that is hosted on codedocs.xyz. For example, > look at my OpenSceneGraph and Doxygen forks: > > https://github.com/paulnovo/osg > https://github.com/paulnovo/doxygen > > I added the "code: documented" badges to the README.md that point to the > latest Doxgyen documentation: > > https://codedocs.xyz/paulnovo/osg/ > https://codedocs.xyz/paulnovo/doxygen/ > > Let me know what you think. Hopefully this will be useful for Doxygen > users. > > -Paul > > ------------------------------------------------------------------------------ > _______________________________________________ > Doxygen-users mailing list > Dox...@li... > https://lists.sourceforge.net/lists/listinfo/doxygen-users |
|
From: Paul N. <pa...@pa...> - 2016-06-13 21:33:20
|
This is due to CodeDocs not supporting all the doxygen configuration options. This restriction should be lifted shortly, as I am working on it now. In the mean time, you can see the currently supported options in the example config file: https://codedocs.xyz/static/codedocs_example.txt Hope this helps. -Paul On Mon, 2016-06-13 at 17:07 -0400, Allen Winter wrote: > Hi Paul, > > I noticed that images (under a top-level folder called 'images') are > not being found. > > My .codedocs file has: > DOXYFILE = Doxyfile > > and my Doxyfile has: > IMAGE_PATH = images > > similar with examples, I think (and EXAMPLE_PATH) > > any idea what I'm doing wrong? > > -Allen > > > On Tuesday, January 05, 2016 08:56:26 PM Paul Novotny wrote: > > Hello, > > > > I put together a GitHub integration for generating and hosting > > Doxygen > > docs for your public GitHub repositories. Consider this an early > > prototype, but I would like to get some testers and feedback. Just > > go > > to: > > > > https://codedocs.xyz/ > > > > You should see a list of your public repositories. Then enable the > > repositories you want Doxygen generated for. A GitHub hook is > > added, so > > the documentation is rebuilt every time you push changes to GitHub. > > You > > can add badges to your README.md (like Coverity, Travis-CI, etc) > > that > > point to the documentation that is hosted on codedocs.xyz. For > > example, > > look at my OpenSceneGraph and Doxygen forks: > > > > https://github.com/paulnovo/osg > > https://github.com/paulnovo/doxygen > > > > I added the "code: documented" badges to the README.md that point > > to the > > latest Doxgyen documentation: > > > > https://codedocs.xyz/paulnovo/osg/ > > https://codedocs.xyz/paulnovo/doxygen/ > > > > Let me know what you think. Hopefully this will be useful for > > Doxygen > > users. > > > > -Paul > > > > ----------------------------------------------------------------- > > ------------- > > _______________________________________________ > > Doxygen-users mailing list > > Dox...@li... > > https://lists.sourceforge.net/lists/listinfo/doxygen-users > |
×
Want the latest updates on software, tech news, and AI?
Get latest updates about software, tech news, and AI from SourceForge directly in your inbox once a month.
Thanks for helping keep SourceForge clean.
X