Skip to content

Conversation

mkoeppe
Copy link
Contributor

@mkoeppe mkoeppe commented Jan 16, 2024

This turns references :envvar:`....` into hyperlinks to the place of the definition. https://deploy-preview-37065--sagemath.netlify.app/html/en/installation/source#environment-variables

Also improving the structure of the section, and some smaller updates.

📝 Checklist

  • The title is concise, informative, and self-explanatory.
  • The description explains in detail what this PR is about.
  • I have linked a relevant issue or discussion.
  • I have created tests covering the changes.
  • I have updated the documentation accordingly.

⌛ Dependencies

Copy link

github-actions bot commented Feb 3, 2024

Documentation preview for this PR (built with commit 6509a98; changes) is ready! 🎉

Copy link
Collaborator

@kwankyu kwankyu left a comment

Choose a reason for hiding this comment

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

LGTM

@kwankyu
Copy link
Collaborator

kwankyu commented Feb 5, 2024

Was this ready for review?

@mkoeppe
Copy link
Contributor Author

mkoeppe commented Feb 5, 2024

Yes, thank you!

vbraun pushed a commit to vbraun/sage that referenced this pull request Feb 7, 2024
sagemathgh-37065: Installation guide: Use `.. envvar::` to define environment variables
    
<!-- ^^^^^
Please provide a concise, informative and self-explanatory title.
Don't put issue numbers in there, do this in the PR body below.
For example, instead of "Fixes sagemath#1234" use "Introduce new method to
calculate 1+1"
-->
<!-- Describe your changes here in detail -->
This turns references ``:envvar:`....` `` into hyperlinks to the place
of the definition. https://deploy-preview-37065--
sagemath.netlify.app/html/en/installation/source#environment-variables

Also improving the structure of the section, and some smaller updates.

<!-- Why is this change required? What problem does it solve? -->
<!-- If this PR resolves an open issue, please link to it here. For
example "Fixes sagemath#12345". -->
<!-- If your change requires a documentation PR, please link it
appropriately. -->

### 📝 Checklist

<!-- Put an `x` in all the boxes that apply. -->
<!-- If your change requires a documentation PR, please link it
appropriately -->
<!-- If you're unsure about any of these, don't hesitate to ask. We're
here to help! -->
<!-- Feel free to remove irrelevant items. -->

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

### ⌛ Dependencies

<!-- List all open PRs that this PR logically depends on
- sagemath#12345: short description why this is a dependency
- sagemath#34567: ...
-->

<!-- If you're unsure about any of these, don't hesitate to ask. We're
here to help! -->
    
URL: sagemath#37065
Reported by: Matthias Köppe
Reviewer(s): Kwankyu Lee
@vbraun vbraun merged commit 60ffcef into sagemath:develop Feb 13, 2024
vbraun pushed a commit to vbraun/sage that referenced this pull request Mar 24, 2024
sagemathgh-37083: HTML documentation: Show preparsed doctests using inline tabs
    
<!-- ^^^^^
Please provide a concise, informative and self-explanatory title.
Don't put issue numbers in there, do this in the PR body below.
For example, instead of "Fixes sagemath#1234" use "Introduce new method to
calculate 1+1"
-->
<!-- Describe your changes here in detail -->
Every doctest block is decorated with tabs, by default showing the
original doctest in **Sage** syntax, and offering a preparsed, pure
**Python** version of it. The tabs are synchronized across the page.

If @kwankyu's live documentation is being built, it is offered as
another tab **Sage (live)**. When this tab is selected, it automatically
starts the Thebe/Binder; it is not necessary to find and push the "Make
live" button.

![tabs-anim](https://github.com/sagemath/sage/assets/8345221/4252ae92-
eeb7-417a-ba24-c141726f714d)

[Preview](https://deploy-preview-37083--sagemath.netlify.app/html/en/ref
erence/function_fields/sage/rings/function_field/function_field_rational
)

<!-- Why is this change required? What problem does it solve? -->
<!-- If this PR resolves an open issue, please link to it here. For
example "Fixes sagemath#12345". -->
Fixes sagemath#35791
<!-- If your change requires a documentation PR, please link it
appropriately. -->

### 📝 Checklist

<!-- Put an `x` in all the boxes that apply. -->
<!-- If your change requires a documentation PR, please link it
appropriately -->
<!-- If you're unsure about any of these, don't hesitate to ask. We're
here to help! -->
<!-- Feel free to remove irrelevant items. -->

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

### ⌛ Dependencies

<!-- List all open PRs that this PR logically depends on
- sagemath#12345: short description why this is a dependency
- sagemath#34567: ...
-->
- Depends on sagemath#37056
- Depends on sagemath#37065

<!-- If you're unsure about any of these, don't hesitate to ask. We're
here to help! -->
    
URL: sagemath#37083
Reported by: Matthias Köppe
Reviewer(s): Kwankyu Lee, Matthias Köppe, Tobias Diez
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants