Yep I thought about putting these credentials into the conf.py file but I
found two major drawbacks :

- If you have several projects you have to duplicate the credentials in all
of them.
- If your project is under source control and you work with other people,
you have to put someone's credentials into source control. This is a very
bad practice :-)

A simple config file into the user's home is more appropriate, don't you
think ?

robin

On Sun, Dec 25, 2011 at 9:25 PM, Max Battcher <m...@worldmaker.net> wrote:

> On Thursday, December 22, 2011, Robin <diabete...@gmail.com> wrote:
> > Hello everyone,
> > I've recently contributed to sphinx-contrib with a "clearquest"
> directive. See http://pypi.python.org/pypi/sphinxcontrib-clearquest/
> > In this extension, there is a connection to a database server and user
> credentials are needed. Since this is not a good idea to store these
> credentials into rst code, I thought of putting them in a separate settings
> file: ~/sphinxcontrib. This is a regular .ini file format with sections
> such as follows
> >
> > [clearquest]
> > username = john
> > password = doe
> > db_name = defects
> > db_set = cq_server
> >
> > If you like the idea, it would be nice to see other sphinx-contrib
> extensions use the same file to store user settings  ;-)
>
> Most extensions I've seen use the sphinx project-level conf.py for these
> sort of settings.
>
> If you can use the conf.py config object, that might be a better idea than
> a home directory folder.
>
> --
> --Max Battcher--
> http://www.worldmaker.net/
>
> --
> You received this message because you are subscribed to the Google Groups
> "sphinx-dev" group.
> To post to this group, send email to sphinx-dev@googlegroups.com.
> To unsubscribe from this group, send email to
> sphinx-dev+unsubscr...@googlegroups.com.
> For more options, visit this group at
> http://groups.google.com/group/sphinx-dev?hl=en.
>

-- 
You received this message because you are subscribed to the Google Groups 
"sphinx-dev" group.
To post to this group, send email to sphinx-dev@googlegroups.com.
To unsubscribe from this group, send email to 
sphinx-dev+unsubscr...@googlegroups.com.
For more options, visit this group at 
http://groups.google.com/group/sphinx-dev?hl=en.

Reply via email to