CastXML / pygccxml

pygccxml is a specialized XML reader that reads the output from CastXML or GCCXML. It provides a simple framework to navigate C++ declarations, using Python classes.
Boost Software License 1.0
131 stars 44 forks source link

Use readthedocs.org to host docs or use to mirror the docs for all released versions #14

Closed luzfcb closed 9 years ago

luzfcb commented 10 years ago

Use readthedocs.org to host docs or use to mirror the docs for all released versions

The ReadTheDocs now integrates with Github Webhooks, then it becomes relatively easy to keep everything up to date

iMichka commented 10 years ago

Hi

thanks for the feedback. I will look into this soon. I am currently writing my thesis so I am quite busy. I should have time at the end of october.

The docs are online on github pages for the moment, so this is not urgent.

luzfcb commented 10 years ago

@iMichka Thanks for the quick response.

but it is relatively simple and quick to do this.

Go the link and log in with your github account:

https://readthedocs.org/accounts/github/login/?process=connect

Then, go the link

https://readthedocs.org/dashboard/import/github/sync/

soon after having loaded the list, click the CREATE button side gccxml/pygccxml.

by default, ReadTheDocs only enable build of latest version to enable more versions, go to https://readthedocs.org/dashboard/pygccxml/versions/

If there are problems in the build of some documentation, I can make the correction and send the pull-request

ps.: sorry for my ugly english.

iMichka commented 10 years ago

Thanks for the explanations. Seems fairly easy. I'll try to have a look in the next weeks if I find some time. There's no hurry :)

iMichka commented 9 years ago

Done in 6a765daf220e379ed149272f4d0a7583e173aa79

I like the design of the docs and the service, it's much easier than having to think about rebuilding the docs manually and to push the to github pages. Thanks :)

The readthedocs overview is broken (https://readthedocs.org/projects/pygccxml/), other pages are working (https://readthedocs.org/builds/pygccxml/). Still, the documentation is built :)

luzfcb commented 9 years ago

Great. Thanks

I had never seen this error before. If it persists for a long time, you may need to open an issue at: https://github.com/rtfd/readthedocs.org

iMichka commented 9 years ago

Yes there was already an issue for this, I added myself to it https://github.com/rtfd/readthedocs.org/issues/945