One potential issue with the new pdoc documentation is how it handles (or
rather doesn't) namespace transclusions.
For example, say you were looking for documentation on
rdkit.Chem.MolFromMolFile. If you go to the rdkit.Chem page for pdoc (
http://rdkit.org/docs_temp/Chem/index.html)
Hi Greg,
Here's my user case: usually I want to find out the details of a
certain class/function I already know of, but I may not have a clue to
which module that class/function belongs to. This is where the
alphabetical index of epydoc is often quite handy. Of course a proper
search within the
Hi, Greg,
Here are my comments.
- Formatting
- pdoc at a glance is certainly more handsome than epydoc
- To my eye, there is a huge amount of wasted space in the pdoc
documentation.
- The line spacing is hugely disproportional to the font size
- Maybe this
Dear all,
TL;DR
I'd like to switch to a new system for generating the RDKit Python API
documentation and I'd like some feedback.
Please take a look at this possible API documentation format:
http://rdkit.org/docs_temp/
and let me know if it looks like it looks as useful as the old API doc
4 matches
Mail list logo
