-
-
Notifications
You must be signed in to change notification settings - Fork 56
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Doc code revision order1 #986
Conversation
Mathics3/mathics-django#201 is needed in Mathics-Django to keep the compatibility |
@@ -67,4 +67,3 @@ is now being repeated. | |||
Yours very truly, | |||
A. Einstein | |||
(Albert Einstein) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
These files where modified automatically by the new pre-commit script...
@@ -594,79 +596,15 @@ def latex(self, doc_data: dict) -> str: | |||
return text | |||
|
|||
|
|||
class LaTeXDocumentation(Documentation): |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This class was never used. The class that we use along the code is LaTeXMathicsDocumentation
.
adb6371
to
75bd82e
Compare
latex_test temporal fixing for utf8 issues in compiling the documentation more tests. catch duplicated entries in DocGuideSections
a5da249
to
1a681d8
Compare
@@ -48,3 +48,11 @@ sed -i -e "s/°/\\\\degree{}/g" documentation.tex | |||
# from Properties in a Section heading. | |||
# TODO: figure out how to fix that bug. | |||
sed -i -e "s/Propertie\\\\/Properties\\\\/g" documentation.tex | |||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This fixes almost all the errors that prevent that mathics.tex from compiling.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Note though that for release we need the reorganization started in #984 which is what motivated all of this refactoring.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I know, and I am trying to go in that direction, trying to work over something that works.
@@ -446,8 +446,9 @@ class PythonCProfileEvaluation(Builtin): | |||
<dd>profile $expr$ with the Python's cProfiler. | |||
</dl> | |||
|
|||
>> PythonCProfileEvaluation[a + b + 1] | |||
= ... | |||
## This produces an error in the LaTeX documentation. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The result of this doctest produces a wrong LaTeX output, that spoils the mathics.pdf generation.
With these changes, the documentation is generated without complaint. |
LGTM |
Another round of incremental changes. This branch requires small tweaks in mathics-django to keep compatibility (just about the names of certain properties in the documentation classes)
mathics.doc.Documentation
class, which seems to be mixed and smashed with theDocChapter
class in an old merge.mathics.doc.Documentation
which does not depend on themathics.builtin
code, which was moved tomathics.doc.MathicsMainDocumentation
.doc-code-revision
.LaTeXDocumentation
were removed.