If I use the default docstring processing, the '||' characters in my doc strings are not processed as table cell delimiters and simply appear in my HTML output.
Will "ClassicStructuredText" be supported in future versions, or should I migrate to some other format for my docstrings?
Also, when I use ClassicStructuredText, python compains:
/usr/local/lib/python2.2/site-packages/happydoclib/docstring/StructuredText/ts_regex.py:87: DeprecationWarning: the regex module is deprecated; please use the re module
import regex, regsub #, Sync
/usr/local/lib/python2.2/regsub.py:15: DeprecationWarning: the regsub module is deprecated; please use re.sub()
DeprecationWarning)
If you would like to refer to this comment somewhere else in this project, copy and paste the following link:
The default formatting was changed from classic to NG because of the regsub deprecation issue. Most classic ST should work with the NG parser, except a few items such as tables (which you have discovered). There is a new table format which supports multi-row cells and is a bit easier to make sense out of when looking at the plain text form.
Classic ST support will always be retained via the parser_docStringFormat option, so you do not need to worry about converting your tables over now.
I do not believe there is any way to eliminate the deprecation warning from the regsub module, so those will continue until you do convert to the NG form.
Doug
If you would like to refer to this comment somewhere else in this project, copy and paste the following link:
First a question:
Now that I'm using happydoc 2.0.1,
to generate HTML tables from docstrings, I need to specify:
happydoc parser_docStringFormat=ClassicStructuredText
my_file.py
If I use the default docstring processing, the '||' characters in my doc strings are not processed as table cell delimiters and simply appear in my HTML output.
Will "ClassicStructuredText" be supported in future versions, or should I migrate to some other format for my docstrings?
Also, when I use ClassicStructuredText, python compains:
/usr/local/lib/python2.2/site-packages/happydoclib/docstring/StructuredText/ts_regex.py:87: DeprecationWarning: the regex module is deprecated; please use the re module
import regex, regsub #, Sync
/usr/local/lib/python2.2/regsub.py:15: DeprecationWarning: the regsub module is deprecated; please use re.sub()
DeprecationWarning)
The default formatting was changed from classic to NG because of the regsub deprecation issue. Most classic ST should work with the NG parser, except a few items such as tables (which you have discovered). There is a new table format which supports multi-row cells and is a bit easier to make sense out of when looking at the plain text form.
Classic ST support will always be retained via the parser_docStringFormat option, so you do not need to worry about converting your tables over now.
I do not believe there is any way to eliminate the deprecation warning from the regsub module, so those will continue until you do convert to the NG form.
Doug