Mathics3 / mathics-core

An open-source Mathematica. This repository contains the Python modules for WL Built-in functions, variables, core primitives, e.g. Symbol, a parser to create Expressions, and an evaluator to execute them.
https://mathics.org
Other
733 stars 42 forks source link

Guides from submodules #1025

Closed mmatera closed 3 months ago

mmatera commented 3 months ago

This is a proposal to start addressing the problem of the guide sections stated in #1023. Changes here requires adjusts in mathics-django too.

mmatera commented 3 months ago

This is how the documentation looks for a module with submodules:

imagen And this is for a shallow module:

imagen

mmatera commented 3 months ago

Things that still need to be fixed:

mmatera commented 3 months ago

Things that still need to be fixed:

* key indices for tests: it seems that by now just works for shallow modules

This seems to work now

  • references: in the LaTeX documentation, some kind of hyperref instead of ref is needed, because the Symbol sections do not have section numbers. In guides, I managed to use page numbers instead of references
rocky commented 3 months ago

Things that still need to be fixed:

* key indices for tests: it seems that by now just works for shallow modules

This seems to work now

* references: in the LaTeX documentation, some kind of hyperref instead of ref is needed, because the Symbol sections do not have section numbers.

In guides, I managed to use page numbers instead of references

I just built the PDF from LaTeX. This is what I see.

arithmetic-functions

Would you please put CubeRoot as 1.1..1 and Accumulate as 1.2.1 and have it numbered? (In LaTeX "section" without the star at the end).

To me, this is kind of formatting is the kind of creativity that is not helpful or desired. Normal tried-and-true book formatting is better.

mmatera commented 3 months ago

To me, this is kind of formatting is the kind of creativity that is not helpful or desired. Normal tried-and-true book formatting is better.

mmatera commented 3 months ago

I just built the PDF from LaTeX. This is what I see.

arithmetic-functions

Would you please put CubeRoot as 1.1..1 and Accumulate as 1.2.1 and have it numbered? (In LaTeX "section" without the star at the end).

@rocky, this is already done in #1022. This is just the slight modification that I proposed in the discussion. Although I am not completely happy with the format in that PR, it seems to align with your point of view. The aim of this branch was to show how the format can be modified to have all the symbols mapped to sections instead of the mix of sections and subsections.

rocky commented 3 months ago

I just built the PDF from LaTeX. This is what I see. arithmetic-functions Would you please put CubeRoot as 1.1..1 and Accumulate as 1.2.1 and have it numbered? (In LaTeX "section" without the star at the end).

@rocky, this is already done in #1022. This is just the slight modification that I proposed in the discussion. Although I am not completely happy with the format in that PR, it seems to align with your point of view. The aim of this branch was to show how the format can be modified to have all the symbols mapped to sections instead of the mix of sections and subsections.

It is close - just add subsection numbers such as for CubeRoot please. Thanks. (Yes, I realize in the last release we didn't do that.)