epydoc Questions

4

Solved

I've got a project which I documented using epydoc. Now I'm trying to switch to sphinx. I formatted all my docstrings for epydocs, using B{}, L{} etc for bolding, linking and the like, and using @p...
Dubiety asked 4/4, 2012 at 14:4

1

Solved

Let's imagine, I want to see a docstring popup for one simple method in PyCharm 4.5 Community Edition (tried also in 5.0). I wrote down these docstrings in both epytext syntax (Epydoc generator is...
Antefix asked 30/8, 2016 at 19:6

1

I'm trying to generate documentation using pdoc, where my docstrings look like this: """ I am a description of what a method does :param param1: an integer :param param2: a str """ I found this...
Serles asked 21/9, 2015 at 20:39

3

Solved

I've not used epydoc in the last 2 years but I found it very handy to take track of my classes and methods with a very little effort. Today I installed latest version 3.0.1 but I get this error an...
Pogge asked 15/7, 2011 at 9:1

3

Solved

There seems to be a plethora of documentation tools for Python. Another one that I've run across is epydoc. It seems like Sphinx is the de facto standard, because it's used to generate the official...
Mandymandych asked 14/3, 2010 at 3:24

1

Solved

I have some methods in my class which are only meant to be used by other methods of the class. I've prefixed their names with '_'. Can I hide those functions from epydoc? Is it a good idea? Should...
Serum asked 4/10, 2011 at 14:34

1

Solved

I am using reStructuredText to document my code, so as to get nice offline HTML pages by means of epydoc. Results are brilliant. The only drawback is that when I use the Python interactive shell, ...
Thunell asked 9/2, 2011 at 20:13
1

© 2022 - 2024 — McMap. All rights reserved.