Skip to content
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

Guides from submodules #1025

Closed
wants to merge 6 commits into from

Conversation

mmatera
Copy link
Contributor

@mmatera mmatera commented Mar 19, 2024

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

@@ -216,7 +216,7 @@ The relative uncertainty of '3.1416`3' is 10^-3. It is numerically equivalent, i
>> 3.1416`3 == 3.1413`4
= True

We can get the precision of the number by using the \Mathics Built-in function <url>:'Precision': /doc/reference-of-built-in-symbols/atomic-elements-of-expressions/representation-of-numbers/precision/</url>:
We can get the precision of the number by using the \Mathics Built-in function <url>:'Precision': /doc/reference-of-built-in-symbols/atomic-elements-of-expressions/precision</url>:
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There are more changes needed like this around, because now symbols are always at the level of the sections.

@mmatera
Copy link
Contributor Author

mmatera commented Mar 19, 2024

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

imagen
And this is for a shallow module:

imagen

@mmatera
Copy link
Contributor Author

mmatera commented Mar 19, 2024

Things that still need to be fixed:

  • key indices for tests: it seems that by now just works for shallow modules
  • references: in the LaTeX documentation, some kind of hyperref instead of ref is needed, because the Symbol sections do not have section numbers.

@mmatera mmatera force-pushed the more_docpipeline_fixes branch 2 times, most recently from 4dd5b72 to cd0d92c Compare March 30, 2024 19:24
mmatera added a commit that referenced this pull request Mar 30, 2024
This PR is another version of #1025, which produces a documentation with
the same format as in the 6.0.4 documentation.
@mmatera
Copy link
Contributor Author

mmatera commented Mar 31, 2024

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

@mmatera mmatera marked this pull request as ready for review March 31, 2024 13:23
@rocky
Copy link
Member

rocky commented Apr 2, 2024

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
Copy link
Contributor Author

mmatera commented Apr 2, 2024

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 mmatera closed this Apr 2, 2024
@mmatera
Copy link
Contributor Author

mmatera commented Apr 2, 2024

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
Copy link
Member

rocky commented Apr 2, 2024

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.)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants