Databases
StackOverflow2013
Postsdbo
POdjango sphinx automodule -- basics
 

Note that there are some explanatory texts on larger screens.

plurals
  1. POdjango sphinx automodule -- basics
    primarykey
    data
    text
    <p>I have a project with several large apps and where settings and apps files are split.</p> <p>directory structure goes something like that:</p> <p><strong>project_name</strong></p> <ul> <li>__init__.py</li> <li>apps <ul> <li>__init__.py</li> <li>app1</li> <li>app2</li> </ul></li> <li>3rdparty <ul> <li>__init__.py</li> <li>lib1</li> <li>lib2</li> </ul></li> <li>settings <ul> <li>__init__.py</li> <li>installed_apps.py</li> <li>path.py</li> <li>templates.py</li> <li>locale.py</li> <li>...</li> </ul></li> <li>urls.py</li> </ul> <p><strong>every app is like that</strong></p> <ul> <li>__init__.py</li> <li>admin <ul> <li>__init__.py</li> <li>file1.py</li> <li>file2.py</li> </ul></li> <li>models <ul> <li>__init__.py</li> <li>model1.py</li> <li>model2.py</li> </ul></li> <li>tests <ul> <li>__init__.py</li> <li>test1.py</li> <li>test2.py</li> </ul></li> <li>views <ul> <li>__init__.py</li> <li>view1.py</li> <li>view2.py</li> </ul></li> <li>urls.py</li> </ul> <p>how to use a sphinx to autogenerate documentation for that?</p> <p>I want something like that for each in settings module or INSTALLED_APPS (not starting with django.* or 3rdparty.*) give me a auto documentation output based on docstring</p> <p>and autogen documentation and run tests before git commit</p> <p>btw. I tried doing .rst files by hand with</p> <pre><code>.. automodule:: module_name :members: </code></pre> <p>but is sucks for such a big project, and it does not works for settings</p> <p>Is there an autogen method or something?</p> <p>I am not tied to sphinx, is there a better solution for my problem?</p>
    singulars
    1. PO
      singulars
      1. PTAnswer
    1. This table or related slice is empty.
    1. PTQuestion
    1. USProf. Falken
    1. USMatt Harasymczuk
    plurals
    1. PL
      singulars
      1. LTLinked
    1. PL
      singulars
      1. LTLinked
    1. This table or related slice is empty.
    1. PO
      singulars
      1. PTAnswer
    2. PO
      singulars
      1. PTAnswer
    1. VO
      singulars
      1. POdjango sphinx automodule -- basics
      1. This table or related slice is empty.
      1. VTUpMod
    2. VO
      singulars
      1. POdjango sphinx automodule -- basics
      1. This table or related slice is empty.
      1. VTUpMod
    3. VO
      singulars
      1. POdjango sphinx automodule -- basics
      1. This table or related slice is empty.
      1. VTUpMod
    1. This table or related slice is empty.
 

Querying!

 
Guidance
A row detail

Detail views are divided into sections. All the information in the data section comes from columns in the selected row. The other sections display data from other, related rows.

Related data can be related in a to-one or a to-many fashion. Captions of data related in a to-many fashion link to a list view showing a filtered view of the table.

Try moving around until you find a non-empty to-many entry and click on the label to get to one. You can move back to the root by clicking on the database name in the header.

SQuiL has stopped working due to an internal error.

If you are curious you may find further information in the browser console, which is accessible through the devtools (F12).

Reload