Databases
StackOverflow2013
Postsdbo
PO
 

Note that there are some explanatory texts on larger screens.

plurals
  1. PO
    primarykey
    data
    text
    <p><a href="http://epydoc.sourceforge.net/" rel="noreferrer">epydoc</a> and <a href="http://sphinx.pocoo.org/" rel="noreferrer">Sphinx</a> are different types of tools. </p> <p>They are the same in that they:</p> <ul> <li>Both use <a href="http://en.wikipedia.org/wiki/ReStructuredText" rel="noreferrer">ReST</a> via <a href="http://docutils.sourceforge.net/" rel="noreferrer">docutils</a>.</li> <li>Both are very Pythonic in their focus</li> <li>Both can generate HTML and PDF documentation</li> </ul> <p>They are different in their focus. </p> <ul> <li>Epydoc is focused on API (Developer) documentation. You get more results quicker with Epydoc. You point it at your source code and you get something. This is what I want from an API documentation tool.</li> <li>Sphinx is focused on general (User) documentation. While Sphinx does pull a lot of information from your source code you need to put a little more into it. Sphinx can generate API documentation but, it's not as straight forward, and IMO doesn't do as good of a job as Epydoc. I know some will disagree because Sphinx is chosen for <a href="http://docs.python.org/dev/" rel="noreferrer">Python</a>. BUT, it depends on how much work you want to put into it. I do love Sphinx for general documentation.</li> </ul> <p>So it depends on how much work you want to put into it and what you are documenting.</p>
    singulars
    1. This table or related slice is empty.
    1. POWhat is the relationship between docutils and Sphinx?
      singulars
      1. PTQuestion
    1. PTAnswer
    1. This table or related slice is empty.
    1. USPaul Hildebrandt
    plurals
    1. This table or related slice is empty.
    1. This table or related slice is empty.
    1. POWhat is the relationship between docutils and Sphinx?
      singulars
      1. PTQuestion
    1. This table or related slice is empty.
    1. VO
      singulars
      1. PO
      1. This table or related slice is empty.
      1. VTUpMod
    2. VO
      singulars
      1. PO
      1. This table or related slice is empty.
      1. VTUpMod
    3. VO
      singulars
      1. PO
      1. This table or related slice is empty.
      1. VTUpMod
    1. COThanks for explaining what these tools have in common (eg their relationship to docutils) as well as their differences. What makes epydoc better for API documentation and Sphinx better for functional documentation? You mentioned that they both use reST. Seems like there's alot of overlap. Is it just a matter of convenience? Also, epydoc development doesn't seem to be very active. The last commit was in Feb 2009, and the last correspondence on the devel list was in May 2009.
      singulars
      1. PO
      1. USallyourcode
    2. COWell, the easy answer to why one is better at one thing that another is that is the way they were designed. Epydoc is made to just pull from the code and Sphinx is made to generate a lot of it's documentation from ReST files you write. There is a lot of overlap. Sphinx is the new kid on the block. I've heard rumors that in .7 it will have much better auto-generation built in. I have a lot of respect for Epydoc but Sphinx seems to have all the momentum right now. I like it because it looks like the python.org documentation AND I think it looks better.
      singulars
      1. PO
      1. USPaul Hildebrandt
    3. COSphinx is not focused on general User documentation. Sphinx is a tool which helps you write a complete and detailed documentation, which you simply cannot provide by concatenating docstrings. Also Sphinx will support so-called domains with 1.0 which will allow you to document a project written in multiple languages for example a webapp written in Python, Javascript and C.
      singulars
      1. PO
      1. USDasIch
 

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