Improving support for Markdown syntaxis in documentation entries. #1026
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
* Fix references in ImportExport * Makes key generation more deterministic * Fix typos in docstrings and comments * Add the new versions of test_* in mathics.docpipeline, and keep the old ones when the new ones fail. * Make more deterministic the key generation for ``DocTest`` * DRY __init__ methods in classes inside latex_doc.py
* Fix references in ImportExport * Makes key generation more deterministic * Fix typos in docstrings and comments * Add the new versions of test_* in mathics.docpipeline, and keep the old ones when the new ones fail. * Make more deterministic the key generation for ``DocTest`` * DRY __init__ methods in classes inside latex_doc.py
removing trailing code
…would be helpful for a future migration to more standard documentation systems.
|
Personally, I think markdown at this stage is a bad idea. Sphinx works best with RsT. ad Also, the regexps to handle this were kind of the wrong way to deal with documentation. Overall I'd like to reduce their use rather than increase their use and add more complexity here. |
|
Ok, I could add the rules for the RST syntax in another branch. |
|
Regarding the implementation, I see this as an intermediate step. This is why I tried to split the parts of the documentation system as much as possible. The long term plan would be
|
mmatera
force-pushed
the
more_docpipeline_fixes
branch
from
2f6eabb to
4dd5b72
Compare
* Fix references in ImportExport * Makes key generation more deterministic * Fix typos in docstrings and comments * Add the new versions of test_* in mathics.docpipeline, and keep the old ones when the new ones fail. * Make more deterministic the key generation for ``DocTest`` * DRY __init__ methods in classes inside latex_doc.py
mmatera
force-pushed
the
more_docpipeline_fixes
branch
from
4dd5b72 to
cd0d92c
Compare
This PR is another version of #1025, which produces a documentation with the same format as in the 6.0.4 documentation.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Adding support for markdown notation in figures and references. This would be helpful for a future migration to more standard documentation systems.