Re-reading of #4927 convert sage.server.* docstrings to Sphinx

[hivert]

File: sage/server/introspect.py

• Some pairs of single quote are transformed to double quote

  - sage: nb.add_user('Mark','password','',force=True) 
  + sage: nb.add_user('Mark','password',",force=True)
  

  - sage: C = sage.server.notebook.cell.Cell(0, 'plot(sin(x),0,5)', '', W) 
  + sage: C = sage.server.notebook.cell.Cell(0, 'plot(sin(x),0,5)', ", W) 
  

It looks like a bad Idea...

I probably miss some so that a systematic replace ,", by ,'', should solve the problem.

• Also in edit_text. the transformation

  Returns a plain-text version of the worksheet with \{\{\{\}\}\} wiki-formatting,
  

into

Returns a plain-text version of the worksheet with {{{}}} 

looks suspicious to me.

• function edit_save: lost {{{ }}}:

  ignore_ids -- bool (default: False); if True ignore all the 
                id's in the {{{}}} code block. 
  

is now:

-  ``ignore_ids`` - bool (default: False); if True 
   ignore all the id's in the code block. 

[mabshoff]

Is anybody working on a patch here?

Cheers,

Michael

[mpatel]

After the merge of #5653, it seems that {{{, }}}, and {{{}}} render properly in the notebook. Try, e.g.,

sage.server.notebook.worksheet.Worksheet.edit_save?
sage.server.notebook.worksheet.Worksheet.edit_text?
sage.server.notebook.notebook.Notebook.import_worksheet?

[mpatel]

The attached patch

• Converts , ", to , '', for in sage.server.* dosctrings.
• Fixes the ignore_ids omission mentioned above. I don't know if there are other instances of this problem.

Are there other problems? Actually, yes. See the next patch, which

• Adds a few modules to notebook.rst.
• Cleans up interact.py's docstrings so they display nicely in the reference manual and notebook.
• Cleans up, e.g., EXAMPLES:, in a few other modules.
• Edits some modules' title strings.

Feel free to make further changes.

[mpatel]

New version. Apply only this patch.

[mpatel]

Ticket #6840 also affects notebook.py and has a similar goal. Most of the changes here are in other files, so I could move part of v2 there.

[mpatel]

Tim Dumol has kindly merged v2 with #6840's v1. Please close this ticket when #6840 merges.

[mvngu]

Closing this ticket as a duplicate of #6840.