Publish to PyPI about sphinx-csharp HOT 6 OPEN

This would make a lot of sense. I've looked into it a bit. However, seeing as a lot of parts would need to be refactored, also in the breathe repo, and I don't have much time for this project I will leave it as is for now. Maybe I will find a bit of time to do this. It would be much nicer from a usability side of course.

from sphinx-csharp.

Well, the current state sort of works, so just publishing as is could be an option. If you don't have the time, I can take that part :)

from sphinx-csharp.

Yea, would be great if you could help out :)

from sphinx-csharp.

It's a great project and kudos to @rogerbarton for your work. Thanks, it is really appreciated.

Anyway, this is for people trying to generate doxygen documentation on the https://readthedocs.org/ and stumbling on this ticket.

Since for now, there isn't a PyPI published package, you can't just add it to requirements.txt. Try adding an installation to your conf.py. It basically a redo of a code from Breathe - Generating doxygen xml files.

# Make sure the the package is a part of the extensions
extensions = ['sphinx_csharp','breathe']

import subprocess, os

read_the_docs_build = os.environ.get('READTHEDOCS', None) == 'True'

if read_the_docs_build:
     subprocess.call('doxygen', shell=True)
     subprocess.call('pip install git+https://github.com/rogerbarton/sphinx-csharp.git', shell=True)    

Disclaimer: I know basically nothing about python, I just wanted to have doxygen generated API and this seems to work.

from sphinx-csharp.

I looked into publishing a pypi package. However, I would need to rename the package to something else... this would also require the breathe repo to use this new package name. I'm not sure if this is worth the hassle. imo pip install git+... is easy enough.

from sphinx-csharp.