moskytw / mosql

Build SQL with native Python data structure smoothly.
http://mosql.mosky.tw
MIT License
140 stars 17 forks source link

Fix the wrong doc caused by monkey patch #11

Closed moskytw closed 11 years ago

moskytw commented 11 years ago

Some of the doc of mosql.util now is covered by mosql.mysql. It is because Sphinx imports all of the modules referred by doc, and the mosql.mysql is a monkey patch for mosql.util.

Solution A: Avoid referred mosql.mysql and such modules in doc. Manually create the doc.

Solution B: Don't use monkey patch anymore.

It should be resolved as soon as possible.

moskytw commented 11 years ago

I found a new solution which you just need to ensure Sphinx don't import the monkey patches.

First, you need to update all doc:

make html

Then, change the modification time of util.rst:

touch util.rst
make html

In this way, Sphinx's autodoc will only import the mosql.util in this compilation, so the mokey patches will not cover the doc of mosql.util.