Ggtcf

What are the advantages of simplicial model categories over non-simplicial ones?

What exact color does ozone gas have?

How do you make your own symbol when Detexify fails?

Mixing PEX brands

Strong empirical falsification of quantum mechanics based on vacuum energy density

Limits and Infinite Integration by Parts

How are Fiends, Celestials, dragons, etc. affected by the Antimagic Field spell?

putting logo on same line but after title, latex

What is Cash Advance APR?

What should you do if you miss a job interview (deliberately)?

Electoral considerations aside, what are potential benefits, for the US, of policy changes proposed by the tweet recognizing Golan annexation?

How do you respond to a colleague from another team when they're wrongly expecting that you'll help them?

What if a revenant (monster) gains fire resistance?

Does malloc reserve more space while allocating memory?

How to say when an application is taking the half of your screen on a computer

How to cover method return statement in Apex Class?

PTIJ: Haman's bad computer

Why Shazam when there is already Superman?

How to hide some fields of struct in C?

Can disgust be a key component of horror?

What are some good ways to treat frozen vegetables such that they behave like fresh vegetables when stir frying them?

Why does a simple loop result in ASYNC_NETWORK_IO waits?

Do the primes contain an infinite almost arithmetic progression?

Plot of a tornado-shaped surface

get pydoc help() to ignore reST (sphinx) syntax?

Substitutions inside links in reST / SphinxMake Sphinx generate RST class documentation from pydocUsing sphinx to create context sensitive html helpCan pydoc/help() hide the documentation for inherited class methods and attributes?RESTful web service API documentation with SphinxDifference between pydoc and help()?Is there a way to prevent display of evaluated defaults in Sphinx documentation?Sphinx vs. Pydocdisplay argparse help within pydocIs there a Sphinx reST Python docstring field for yields?

0

I have some function definitions like this:

def abc(arrg1):
 """
 do something
 :param arrg1: a string like ``'gogo'``
 """
 if arrg1=='gogo':
 print('success')

which generates into a nice Sphinx HTML document formatted like this:

abc(arrg1)
 do something 

 Parameters:

• 
  arrg1 – a string like 'gogo'
  

but in the interactive terminal, it looks really confusing, especially for new users or non-programmers:

>>> help(abc)
Help on function abc in module __main__:

abc(arrg1)
 do something
 :param arrg1: a string like ``'gogo'``

I'm specifically referring to this:

``'gogo'``

it's really unhelpful for the new users, who often use these sort of pydoc help commands.

---

Is there any way to make the help output cleaner, basically ignoring/stripping the backticks?

python documentation python-sphinx pydoc

share|improve this question

asked Mar 8 at 1:46

nmz787nmz787

8841926

• 
  
  
  

  
  

  
  
  
  
  
  

  
  
  Python already isn't a HTML language...
  
  – U9-Forward
  Mar 8 at 2:16
  
  

  
  
  
  


• 
  
  
  

  
  

  
  
  
  
  
  

  
  
  IMO, using double backticks is confusing. Suggest their removal.
  
  – Steve Piercy
  Mar 8 at 5:01
  

  
  
  
  


• 
  
  
  

  
  

  
  
  
  
  
  

  
  
  @StevePiercy confusing when in interactive mode, yes, but they make the online documentation easier to read
  
  – nmz787
  Mar 8 at 7:48
  

  
  
  
  


• 
  
  
  

  
  

  
  
  
  
  
  

  
  
  @U9-Forward umm, I'm not sure how to respond... I'm using the documentation-generator Sphinx to generate the HTML docs...
  
  – nmz787
  Mar 8 at 7:49
  

  
  
  
  

add a comment | 

0

I have some function definitions like this:

def abc(arrg1):
 """
 do something
 :param arrg1: a string like ``'gogo'``
 """
 if arrg1=='gogo':
 print('success')

which generates into a nice Sphinx HTML document formatted like this:

abc(arrg1)
 do something 

 Parameters:

• 
  arrg1 – a string like 'gogo'
  

but in the interactive terminal, it looks really confusing, especially for new users or non-programmers:

>>> help(abc)
Help on function abc in module __main__:

abc(arrg1)
 do something
 :param arrg1: a string like ``'gogo'``

I'm specifically referring to this:

``'gogo'``

it's really unhelpful for the new users, who often use these sort of pydoc help commands.

---

Is there any way to make the help output cleaner, basically ignoring/stripping the backticks?

python documentation python-sphinx pydoc

share|improve this question

asked Mar 8 at 1:46

nmz787nmz787

8841926

• 
  
  
  

  
  

  
  
  
  
  
  

  
  
  Python already isn't a HTML language...
  
  – U9-Forward
  Mar 8 at 2:16
  
  

  
  
  
  


• 
  
  
  

  
  

  
  
  
  
  
  

  
  
  IMO, using double backticks is confusing. Suggest their removal.
  
  – Steve Piercy
  Mar 8 at 5:01
  

  
  
  
  


• 
  
  
  

  
  

  
  
  
  
  
  

  
  
  @StevePiercy confusing when in interactive mode, yes, but they make the online documentation easier to read
  
  – nmz787
  Mar 8 at 7:48
  

  
  
  
  


• 
  
  
  

  
  

  
  
  
  
  
  

  
  
  @U9-Forward umm, I'm not sure how to respond... I'm using the documentation-generator Sphinx to generate the HTML docs...
  
  – nmz787
  Mar 8 at 7:49
  

  
  
  
  

add a comment | 

I have some function definitions like this:

def abc(arrg1):
 """
 do something
 :param arrg1: a string like ``'gogo'``
 """
 if arrg1=='gogo':
 print('success')

which generates into a nice Sphinx HTML document formatted like this:

abc(arrg1)
 do something 

 Parameters:

• 
  arrg1 – a string like 'gogo'
  

but in the interactive terminal, it looks really confusing, especially for new users or non-programmers:

>>> help(abc)
Help on function abc in module __main__:

abc(arrg1)
 do something
 :param arrg1: a string like ``'gogo'``

I'm specifically referring to this:

``'gogo'``

it's really unhelpful for the new users, who often use these sort of pydoc help commands.

---

Is there any way to make the help output cleaner, basically ignoring/stripping the backticks?

python documentation python-sphinx pydoc

share|improve this question

asked Mar 8 at 1:46

nmz787nmz787

8841926

def abc(arrg1):
 """
 do something
 :param arrg1: a string like ``'gogo'``
 """
 if arrg1=='gogo':
 print('success')

>>> help(abc)
Help on function abc in module __main__:

abc(arrg1)
 do something
 :param arrg1: a string like ``'gogo'``

``'gogo'``

share|improve this question

asked Mar 8 at 1:46

nmz787nmz787

8841926

share|improve this question

asked Mar 8 at 1:46

nmz787nmz787

8841926

asked Mar 8 at 1:46

nmz787nmz787

8841926

asked Mar 8 at 1:46

nmz787nmz787

8841926