Skip to content Skip to sidebar Skip to footer
Showing posts with the label Documentation
How To Add My Own "help" Information To A Python Function/class?

How To Add My Own "help" Information To A Python Function/class?

Post a Comment
I know I can use 'help()' to see existing help information from packages. But after I wrote… Read more How To Add My Own "help" Information To A Python Function/class?
Omit (or Format) The Value Of A Variable When Documenting With Sphinx

Omit (or Format) The Value Of A Variable When Documenting With Sphinx

Post a Comment
I'm currently documenting a whole module with autodoc. However, I define several variables on t… Read more Omit (or Format) The Value Of A Variable When Documenting With Sphinx
Substitution In Admonitions

Substitution In Admonitions

Post a Comment
How can I do a substitution in an admonition? For example: |p| account .. note:: **Been using… Read more Substitution In Admonitions
What's The Difference On Docstrings With Triple Single Quotes And Triple Double Quotes?

What's The Difference On Docstrings With Triple Single Quotes And Triple Double Quotes?

Post a Comment
I was just wondering what is the difference between two ways of writing Python Docstrings (__doc__)… Read more What's The Difference On Docstrings With Triple Single Quotes And Triple Double Quotes?
Substitution In Admonitions

Substitution In Admonitions

Post a Comment
How can I do a substitution in an admonition? For example: |p| account .. note:: **Been using… Read more Substitution In Admonitions