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

HTML documentation: Right-align Sage / Python inline tabs, use vertical kerning #37760

Closed
mkoeppe opened this issue Apr 6, 2024 · 1 comment · Fixed by #38568
Closed

HTML documentation: Right-align Sage / Python inline tabs, use vertical kerning #37760

mkoeppe opened this issue Apr 6, 2024 · 1 comment · Fixed by #38568

Comments

@mkoeppe
Copy link
Member

mkoeppe commented Apr 6, 2024

Screenshot 2024-04-06 at 1 19 37 PM -----> Screenshot 2024-04-06 at 1 19 37 PM
@AndrewMathas
Copy link
Member

AndrewMathas commented Aug 28, 2024

If I understand what you want, this just needs a few tweaks to the margins in the tabs.css files:
Screenshot 2024-08-28 at 11 47 38
which results in:
Screenshot 2024-08-28 at 11 55 25
I'd be happy to do this, but I have not played with the documentation in sage before, so I don't know where it lives. In particular, I don't see this file anywhere in $SAGE_ROOT/src/doc. The file does appear many times in $SAGE_ROOT/local, but this directory is not under version control.

vbraun pushed a commit to vbraun/sage that referenced this issue Sep 8, 2024
…cing

    
<!-- ^ Please provide a concise and informative title. -->
<!-- ^ Don't put issue numbers in the title, do this in the PR
description below. -->
<!-- ^ For example, instead of "Fixes sagemath#12345" use "Introduce new method
to calculate 1 + 2". -->
<!-- v Describe your changes below in detail. -->
<!-- v Why is this change required? What problem does it solve? -->
<!-- v If this PR resolves an open issue, please link to it here. For
example, "Fixes sagemath#12345". -->

Fixes sagemath#37760

The css will push the tabs all the way to the right and alter the
vertical spacing so that they are more "in-line".  The vertical spacing
causes some issues as sometimes the text from the previous line will run
into the tabs. To fix this, the previous line now has a `max-width` of
`80%` so that they won't overlap.  This also makes it so that the
`EXAMPLES:` line is on the same line as tabs. (As far as I could tell,
there was no way to distinguish the `EXAMPLES:` text from other text).

A good page to see the changes is on:
`en/reference/rings_standard/sage/rings/integer_ring.html`
as it contains various different formats for sage/python examples.

### 📝 Checklist

<!-- Put an `x` in all the boxes that apply. -->

- [x] The title is concise and informative.
- [x] The description explains in detail what this PR is about.
- [x] I have linked a relevant issue or discussion.
- [ ] I have created tests covering the changes.
- [x] I have updated the documentation and checked the documentation
preview.

### ⌛ Dependencies

<!-- List all open PRs that this PR logically depends on. For example,
-->
<!-- - sagemath#12345: short description why this is a dependency -->
<!-- - sagemath#34567: ... -->
- Depends on sagemath#38468 (merged here)
    
URL: sagemath#38568
Reported by: Aram Dermenjian
Reviewer(s): Andrew Mathas, Aram Dermenjian, Kwankyu Lee, Matthias Köppe
vbraun pushed a commit to vbraun/sage that referenced this issue Sep 8, 2024
…cing

    
<!-- ^ Please provide a concise and informative title. -->
<!-- ^ Don't put issue numbers in the title, do this in the PR
description below. -->
<!-- ^ For example, instead of "Fixes sagemath#12345" use "Introduce new method
to calculate 1 + 2". -->
<!-- v Describe your changes below in detail. -->
<!-- v Why is this change required? What problem does it solve? -->
<!-- v If this PR resolves an open issue, please link to it here. For
example, "Fixes sagemath#12345". -->

Fixes sagemath#37760

The css will push the tabs all the way to the right and alter the
vertical spacing so that they are more "in-line".  The vertical spacing
causes some issues as sometimes the text from the previous line will run
into the tabs. To fix this, the previous line now has a `max-width` of
`80%` so that they won't overlap.  This also makes it so that the
`EXAMPLES:` line is on the same line as tabs. (As far as I could tell,
there was no way to distinguish the `EXAMPLES:` text from other text).

A good page to see the changes is on:
`en/reference/rings_standard/sage/rings/integer_ring.html`
as it contains various different formats for sage/python examples.

### 📝 Checklist

<!-- Put an `x` in all the boxes that apply. -->

- [x] The title is concise and informative.
- [x] The description explains in detail what this PR is about.
- [x] I have linked a relevant issue or discussion.
- [ ] I have created tests covering the changes.
- [x] I have updated the documentation and checked the documentation
preview.

### ⌛ Dependencies

<!-- List all open PRs that this PR logically depends on. For example,
-->
<!-- - sagemath#12345: short description why this is a dependency -->
<!-- - sagemath#34567: ... -->
- Depends on sagemath#38468 (merged here)
    
URL: sagemath#38568
Reported by: Aram Dermenjian
Reviewer(s): Andrew Mathas, Aram Dermenjian, Kwankyu Lee, Matthias Köppe
vbraun pushed a commit to vbraun/sage that referenced this issue Sep 10, 2024
…cing

    
<!-- ^ Please provide a concise and informative title. -->
<!-- ^ Don't put issue numbers in the title, do this in the PR
description below. -->
<!-- ^ For example, instead of "Fixes sagemath#12345" use "Introduce new method
to calculate 1 + 2". -->
<!-- v Describe your changes below in detail. -->
<!-- v Why is this change required? What problem does it solve? -->
<!-- v If this PR resolves an open issue, please link to it here. For
example, "Fixes sagemath#12345". -->

Fixes sagemath#37760

The css will push the tabs all the way to the right and alter the
vertical spacing so that they are more "in-line".  The vertical spacing
causes some issues as sometimes the text from the previous line will run
into the tabs. To fix this, the previous line now has a `max-width` of
`80%` so that they won't overlap.  This also makes it so that the
`EXAMPLES:` line is on the same line as tabs. (As far as I could tell,
there was no way to distinguish the `EXAMPLES:` text from other text).

A good page to see the changes is on:
`en/reference/rings_standard/sage/rings/integer_ring.html`
as it contains various different formats for sage/python examples.

### 📝 Checklist

<!-- Put an `x` in all the boxes that apply. -->

- [x] The title is concise and informative.
- [x] The description explains in detail what this PR is about.
- [x] I have linked a relevant issue or discussion.
- [ ] I have created tests covering the changes.
- [x] I have updated the documentation and checked the documentation
preview.

### ⌛ Dependencies

<!-- List all open PRs that this PR logically depends on. For example,
-->
<!-- - sagemath#12345: short description why this is a dependency -->
<!-- - sagemath#34567: ... -->
- Depends on sagemath#38468 (merged here)
    
URL: sagemath#38568
Reported by: Aram Dermenjian
Reviewer(s): Andrew Mathas, Aram Dermenjian, Kwankyu Lee, Matthias Köppe
vbraun pushed a commit to vbraun/sage that referenced this issue Sep 12, 2024
…cing

    
<!-- ^ Please provide a concise and informative title. -->
<!-- ^ Don't put issue numbers in the title, do this in the PR
description below. -->
<!-- ^ For example, instead of "Fixes sagemath#12345" use "Introduce new method
to calculate 1 + 2". -->
<!-- v Describe your changes below in detail. -->
<!-- v Why is this change required? What problem does it solve? -->
<!-- v If this PR resolves an open issue, please link to it here. For
example, "Fixes sagemath#12345". -->

Fixes sagemath#37760

The css will push the tabs all the way to the right and alter the
vertical spacing so that they are more "in-line".  The vertical spacing
causes some issues as sometimes the text from the previous line will run
into the tabs. To fix this, the previous line now has a `max-width` of
`80%` so that they won't overlap.  This also makes it so that the
`EXAMPLES:` line is on the same line as tabs. (As far as I could tell,
there was no way to distinguish the `EXAMPLES:` text from other text).

A good page to see the changes is on:
`en/reference/rings_standard/sage/rings/integer_ring.html`
as it contains various different formats for sage/python examples.

### 📝 Checklist

<!-- Put an `x` in all the boxes that apply. -->

- [x] The title is concise and informative.
- [x] The description explains in detail what this PR is about.
- [x] I have linked a relevant issue or discussion.
- [ ] I have created tests covering the changes.
- [x] I have updated the documentation and checked the documentation
preview.

### ⌛ Dependencies

<!-- List all open PRs that this PR logically depends on. For example,
-->
<!-- - sagemath#12345: short description why this is a dependency -->
<!-- - sagemath#34567: ... -->
- Depends on sagemath#38468 (merged here)
    
URL: sagemath#38568
Reported by: Aram Dermenjian
Reviewer(s): Andrew Mathas, Aram Dermenjian, Kwankyu Lee, Matthias Köppe
@vbraun vbraun closed this as completed in 468d3ee Sep 15, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants