CODEWITHSUNDEEP
pythondocumentationspyder
Marco Fumagalli
Marco Fumagalli

Reputation: 2477

Fancy python docs in Spyder

I'm writing some documentation in Python using Spyder as IDE.

For example I have a function:

def TestFunction(args1,args2):
    """
    General Description

    Args:
        args1: describing
        args2: describing
    Return:
        data
    """
       ...code here....

Is it possible to make the documentation more fancy with words in bold or italics etc etc. Any reference?

Thanks

Upvotes: 0

Views: 790

Answers (2)

NaN
NaN

Reputation: 2322

I use numpy a lot, so I installed numpydoc and it enabled 'automatic connections' in the help under preferences.

help, automatic connections

It does a nice job enter image description here

Upvotes: 1

Carlos Cordoba
Carlos Cordoba

Reputation: 34156

(Spyder maintainer here) It's possible to make your docs fancier by following the conventions of Restructured text. You can find its specification here.

Upvotes: 2

Related Questions