Hi All,
I apologize in advance if my question sounds dumb. I googled back
and forth but my google-fu today is not working very well...
I have seen the new style Python html documentation, which is
extremely nice, and by reading here and there I have seen that it has
been generated using Georg Brandl's Sphinx package (http://
pypi.python.org/pypi/Sphinx).
Now, I have an open source application I am documenting, and I would
like to use the new html style, so I thought: to use Sphinx to obtain
the same result. The problem is, I don't know if there is a tool out
there which will extract docstrings from my module and convert them to
a RestructuredText formal which may be (almost) directly fed into
Sphinx to get the html help.
Maybe I am asking the impossible, or maybe it is much easier than I
thought, but I can't find a solution, so I thought to ask here...
Thank you in advance for your suggestions.
Andrea.
1  3103 
On Oct 1, 4:10*pm, Infinity77 <andrea.gav...@gmail.comwrote:
Hi All,
* * I apologize in advance if my question sounds dumb. I googled back
and forth but my google-fu today is not working very well...
I have seen the new style Python html documentation, which is
extremely nice, and by reading here and there I have seen that it has
been generated using Georg Brandl's Sphinx package (http://
pypi.python.org/pypi/Sphinx).
Now, I have an open source application I am documenting, and I would
like to use the new html style, so I thought: to use Sphinx to obtain
the same result. The problem is, I don't know if there is a tool out
there which will extract docstrings from my module and convert them to
a RestructuredText formal which may be (almost) directly fed into
Sphinx to get the html help.
Maybe I am asking the impossible, or maybe it is much easier than I
thought, but I can't find a solution, so I thought to ask here...
Sphinx has an extension called autodoc that can extract docs from
docstrings.
>
Thank you in advance for your suggestions.
Andrea.
This thread has been closed and replies have been disabled. Please start a new discussion. Similar topics
by: David Goodger |
last post by:
I whipped together a cheat sheet for reStructuredText:
1 page for syntax, and a 1 page reference for directives
and roles. Please take a look:
<http://docutils.sf.net/docs/rst/cheatsheet.txt>...
|
by: Sridhar R |
last post by:
When writing a python library, we can use docstrings for methods and
functions that are part of API. But what about comments for non-API
objects or python application code?
For applications,...
|
by: Kamilche |
last post by:
I have a large project that is getting complex, and I would like to
print the docstrings without importing the modules. The only Python
utility I could find references is apparently defunct and...
|
by: Jim |
last post by:
Hi,
I'm using reStructuredText as a format for some group documentation,
and often my co-workers take notes during meetings in Word's outline
mode. Does anyone already have a python script that...
|
by: kpp9c |
last post by:
I would like to use the power of Python to build some list structures
for me.
Namely i have organized a bunch of folders that have soundfiles in them
and would like Python to slurp up all the...
|
by: Lawrence D'Oliveiro |
last post by:
The Python docs recommend the use of triple-quoted string literals for
docstrings, e.g.
def Meet(Alice, Bob) :
"""arranges a meeting between Alice and Bob.
Returns a reference to the meeting...
|
by: bartonc |
last post by:
You will be rewarded sooner than you think when you use docstrings to document your classes and functions. Whether you ever intend to publish your work or not, docstrings will help you in several...
|
by: Calvin Cheng |
last post by:
Hi,
I am attempting to convert a bunch of .txt files into html using the
docutils package.
It works for most of the txt files except for the index.txt file which
gives 2 errors:
(1)...
|
by: Glenn Hutchings |
last post by:
Hi there Pythonistas...
I'm writing documentation for a non-Python program using Sphinx
(http://sphinx.pocoo.org), which is great. The program has an input
file syntax suitable for highlighting...
|
by: emmanuelkatto |
last post by:
Hi All, I am Emmanuel katto from Uganda. I want to ask what challenges you've faced while migrating a website to cloud.
Please let me know.
Thanks!
Emmanuel
|
by: Sonnysonu |
last post by:
This is the data of csv file
1 2 3
1 2 3
1 2 3
1 2 3
2 3
2 3
3
the lengths should be different i have to store the data by column-wise with in the specific length.
suppose the i have to...
|
by: marktang |
last post by:
ONU (Optical Network Unit) is one of the key components for providing high-speed Internet services. Its primary function is to act as an endpoint device located at the user's premises. However,...
|
by: Hystou |
last post by:
Most computers default to English, but sometimes we require a different language, especially when relocating. Forgot to request a specific language before your computer shipped? No problem! You can...
|
by: Oralloy |
last post by:
Hello folks,
I am unable to find appropriate documentation on the type promotion of bit-fields when using the generalised comparison operator "<=>".
The problem is that using the GNU compilers,...
|
by: Hystou |
last post by:
Overview:
Windows 11 and 10 have less user interface control over operating system update behaviour than previous versions of Windows. In Windows 11 and 10, there is no way to turn off the Windows...
|
by: tracyyun |
last post by:
Dear forum friends,
With the development of smart home technology, a variety of wireless communication protocols have appeared on the market, such as Zigbee, Z-Wave, Wi-Fi, Bluetooth, etc. Each...
|
by: agi2029 |
last post by:
Let's talk about the concept of autonomous AI software engineers and no-code agents. These AIs are designed to manage the entire lifecycle of a software development project—planning, coding, testing,...
|
by: isladogs |
last post by:
The next Access Europe User Group meeting will be on Wednesday 1 May 2024 starting at 18:00 UK time (6PM UTC+1) and finishing by 19:30 (7.30PM).
In this session, we are pleased to welcome a new...
| |
