#sphinx-doc

[02sphinx] 07shimizukawa pushed 031 commit to 03stable [+1/-0/±0] 13http://git.io/ve87Z

[02sphinx] 07shimizukawa 032ee54df - add make.bat for sphinx/doc

hi. i'm looking for a way to customize sphinx-apidoc output like this: http://stackoverflow.com/questions/29385564/cus... , anyone know if this is possible?

seems there are quite a few questions on SO about customizing the sphinx-apidoc output. how come it's not templatized?

the ToC really has a lot of redundant info. e.g. "xx.xx.xx package" under a heading called "Subpackages", and also writing out the full names of modules (including package) in each ToC entry (its package is obvious from the position in the ToC).

Hi there, Is there a way to install Sphinx-Doc on Mac OSX without MacPorts? A Homebrew formula or other method? Using Mavericks 10.9.5. Thanks in advance?

!

I use virtual envs

ah, so Linux or another OS? I have homebrew, but am concerned that MacPorts may change the file paths…

MacOS

homebrew is fine

have it installed as well

basically virtualenv gives you an isolated environment

tons of tutorials available

beond: pip install sphinx, in a virtualenv if you'dl ike, sure

after activating your virtualenv, you

I tried homebrew but it wasn’t the correct Sphinx-doc package.

This is not sphinx - the Python Documentation Generator.

pip install -U pip

To install sphinx-python: use pip or easy_install,

Sphinx has been compiled with libstemmer support.

pip install sphinx

Sphinx depends on either MySQL or PostreSQL as a datasource.

You can install these with Homebrew with:

brew install mysql

For MySQL server.

brew install mysql-connector-c

For MySQL client libraries only.

brew install postgresql

For PostgreSQL server.

We don't install these for you when you install this formula, as

we don't know which datasource you intend to use.

==> Summary

lots of packages are available as wheels this way -> fast installation

🍺 /usr/local/Cellar/sphinx/2.2.5: 15 files, 18M

beond: homebrew doesn't install packages that other package managers can install.

yes, the pip commands don’t work on MacOS

I don’t believe easy_install works either…

beond: define "don't work"

beond: https://pypi.python.org/pypi/virtualenv

pip works but should be updated

trust me, I am a mac user

I believe you. Sorry just now reading through the virtualenv instructions

virtualenv might not be for you if your main interest is in system scripting

but as soon as you work on a python project (something with a setup.py) you probably are best of

for using virtualenv I like https://virtualenvwrapper.readthedocs.org/en/la...

My main purpose in wanting to install Sphinx is to update documentation that a colleague started in Sphinx. I have no experience in Python, and so wanted to use it without installing a language (much like Doxygen) if possible?

So would you recommend installing: virtualenv-12.0.7-py2.py3-none-any.whl (md5, pgp)

and then installing Python on that virtual env, to then access Sphinx?

tos9: apologies for being vague. When I use the pip command, it looks like this:

>>>>>>>>>>>> pip install -U pip

-bash: pip: command not found

if you have brew you can install virtualenv from there

pyenv-virtualenv pyenv-virtualenvwrapper afaik

sphinx is great for documenting python, you are right

so you would recommend: http://hackercodex.com/guide/python-development...

?

beond: just briefly scanning that it seems fine.

beond: install python with homebrew so that you've got one that isn't the system python, and then use the pip that you'll have with it

with virtualenv if you feel like it.

ok, sounds like a plan : )

looks alright

upon activating your virtualenv

do not forget to update pip

then you will benefit from wheels built for macos, that are binary packages that quickly install

okay. Is there an update command for pip?

because I’m unfamiliar with python, not sure about the “wheels” analogy. Are they like “gems” in Ruby?

sort of yes

do you recommend just brew install python or brew install python3?

depends which version of Python you are going to develop for

if you don't have a preference, you probably want `brew install python`

I’m not developing, only wanting to run Sphinx

sphinx requires a development environment though

at least if you want to use sphinx-apidoc, etc.

beond: on a package presumably? is the package python2 or python3?

the source documentation is in C

no python code?

then I would probably opt for python2

but that is not a strong preference

not that I’m aware of. I don’t know why the developer chose Sphinx instead of Doxygen, but as it now lives in that form, that’s what I’m working from

Cool. So python is installed and now it’s giving me the option to update and use pip

Downloading setuptools-15.0-py2.py3-none-any.whl (501kB)

beond: ah, ok, yeah then it doesn't matter

so I’ve gotten to the foobar step. I have: New python executable in foobar/bin/python2.7

Also creating executable in foobar/bin/python