I see your point, I think I will keep the home dir file but will give the possibility to put the credentials in conf.py as well.
thanks for the feedback :) On Wed, Dec 28, 2011 at 2:21 PM, Max Battcher <m...@worldmaker.net> wrote: > On Tuesday, December 27, 2011, Robin <diabete...@gmail.com> wrote: > > 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 ? > > conf.py is a Python file. Leaving it in the conf.py lets the user decide > in code how they want to store the credentials. For instance, a conf.py > might inherit the settings from a shared python module in a user's path > that isn't in source control, or a user may choose to read them from > file(s) of their choice… > > There is a lot of relatively common knowledge around such things as > database settings in python config files in the Django world, if you want > to find other examples "in the wild". > > My suggestion would be to use conf.py and include in your extension > documentation examples of coding conf.py to use credentials stored in other > files/modules… That way you give your user the per-project and pure python > flexibility they might need. Does that make sense? > > > -- > --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.
