Docpipeline working part #1009
Docpipeline working part #1009
Conversation
mathics/docpipeline.py
Outdated
| @@ -43,11 +43,6 @@ def max_stored_size(self, _): | |||
|
|
|||
|
|
|||
| # Global variables | |||
| definitions = None | |||
There was a problem hiding this comment.
Trailing lines from the v6.0 version.
| # | ||
| # TODO: Split and simplify this section | ||
| # | ||
| # |
There was a problem hiding this comment.
I guess this function still requires work. In general, test_tests/test_sections/test_chapters/test_all doesn't seem to take advantage of the new organization in common_doc.
mathics/docpipeline.py
Outdated
| return total, failed, skipped, failed_symbols, index | ||
|
|
||
|
|
||
| def test_tests_old( |
There was a problem hiding this comment.
I keep the old version here, because the new version is not working.
| @@ -481,72 +481,7 @@ class LaTeXDocTest(DocTest): | |||
| """ | |||
|
|
|||
| def __init__(self, index, testcase, key_prefix=None): | |||
| def strip_sentinal(line): | |||
| @@ -916,23 +832,6 @@ def __init__( | |||
| super().__init__( | |||
| chapter, section, title, text, operator, installed, in_guide, summary_text | |||
| ) | |||
| self.doc = LaTeXDocumentationEntry(text, title, section) | |||
mmatera
force-pushed
the
docpipeline_working_part
branch
from
38870c6 to
2b3602f
Compare
|
I was looking at this earlier. It is good to see the LaTeX document build again. Something to keep in mind. Chapters in the Reference part, part 1 should not be sorted by either chapter or section. In this branch, tests appear sorted by chapter in part 1. And in the LaTeX doc the sections in part 1 are also sorted. Part of the problem here is that I removed the "sort" parameter that allows one to specify whether or not to sort chapters and sections. In master, you'll find a sort-order field for chapters for part 1 chapters. The logic of this branch follows the older logic where tests are accessed by document sequentially and they happen to come out ordered by section and chapter. One reason it is useful to have routines to get tests by chapter or section is that sometimes we want to run just the tests or update documentation for just section or chapter. For the tests one can get direct access using a slug name. |
* 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
docpipeline_working_part
branch
from
96b64bd to
c1551cb
Compare
Yes, I am aware of that, but the problem is that right now, it is not working. What I tried to do is to isolate what is not working, and then see if we can fix it. |
|
superseded by #1021 |
This is another layer of improvements in the documentation system.
ImportExportdocumentation.keyattribute inmathics.doc.common.DocTestbe more deterministic.__init__routines inlatex_docsubclasses.