Releases: lsst-sqre/technote
0.9.0
Backwards-incompatible changes.
- Technote no longer uses the
sphinx-basic-ng
theme. Users that depended in thesphinx-basic-ng
themes HTML and class structure for theming will need to update their CSS.
New features
-
Technote now features a two-column layout. The left column contains the table of contents and metadata, while the right column contains the content. This layout allows for wide content to "bleed" into the whitespace to the right of the content column. With this change, we've dropped the CSS patterns from the
sphinx-basic-ng
theme. The Technote layout is now built around CSS grid. -
Wide content (such as figures, tables, and code blocks) can now extend past the content column if the author sets the
technote-wide-content
class on the content. This class is applied as afigclass
option in figures or as a precedingrst-class
directive to tables and code blocks.
What's Changed
- DM-44542: Two column layout by @jonathansick in #49
- DM-44542: Prepare 0.9.0 release by @jonathansick in #50
Full Changelog: 0.8.0...0.9.0
0.9.0a2
Additional refinements to the technote CSS; especially for wide content.
0.9.0a1
This is an interim release with the new grid-based layout for technotes. With this layout, a .technote-wide-content
class can be added to images, tables, code-blocks, and more to let that content bleed into the whitespace on the right side of the window.
0.8.0
New features
- Changed how the base font size is set. The base font size on the
html
element is now 100% to explicitly respect the user's settings. Therem
unit is now relative to those user settings as well. - The "default" font size is now set on the
body
element with the--tn-component-text-font-size
CSS property. This is set to1.1rem
by default to maintain the original look. The header sizes are now relative to the user font size, but the smaller sizes have been increased slightly. - The font size for
code
is now set to0.9em
. This slightly smaller size helps avoid a baseline misalignment issue for the monospace text in the paragraph. - The
pre
font size is1rem
, which is slightly smaller than the text font size. - New
--tn-component-code-font-family
CSS property. This is used for monospace fonts in code blocks and inline code. The default isui-monospace
, which gives SF Mono on macOS.
Other changes
- Pin
pytest < 8.0
due to a change in test sessions that's incompatible with running a technote Sphinx build repeatedly on different projects. This change is temporary until we update the project builder for tests to run in subprocesses for isolation.
What's Changed
- DM-42626: Fix configuration documentation for intersphinx by @rra in #45
- DM-43638: Fix baseline mis-alignment for monospace inline text by @jonathansick in #47
New Contributors
Full Changelog: 0.7.0...0.8.0
0.8.0a1
0.7.0
New features
-
When the
technote.date_updated
field intechnote.toml
is not set, the update date internally defaults to "now" (the build time). This ensures that documents always carry some form of metadata about when they were modified. -
Code samples without captions (unwrapped
.highlight
divs) now have borders and are protected against x-overflow. This matches the behavior of code samples with captions. -
All code samples have negative left margin equal to their content padding so that the code lines up with the text column.
-
The content (
div.sb-container
) now has bottom margin to give content breathing room.
What's Changed
- Fix docs mentioning date_modified by @jonathansick in #42
- DM-42705: Default to now if date_updated is not set by @jonathansick in #43
- DM-42711: Improve code samples without captions by @jonathansick in #44
Full Changelog: 0.6.2...0.7.0
0.7.0a1
What's Changed
- Fix docs mentioning date_modified by @jonathansick in #42
Full Changelog: 0.6.2...0.7.0a1
0.6.2
Bug fixes
- Fix the
technote.ext.pygmentsscss
extension to handle cases where the HTML builder isn't being run.
What's Changed
- DM-42142: Update pygments extension to work with linkcheck builder by @jonathansick in #41
Full Changelog: 0.6.1...0.6.2
0.6.1
Bug fixes
- The
technote.ext.wraptables
andtechnote.ext.insertposttitles
extensions now gracefully handle cases when anindex.html
file does not exist. A reason for this might be that the build is running through the linkcheck builder.
What's Changed
- DM-42124: Handle non-html builders for extensions by @jonathansick in #40
Full Changelog: 0.6.0...0.6.1
0.6.0
New features
-
Add
#svg-octicon-versions-16
to theocticons.html
sprite template. This icon is useful for linking to alternative versions of a technote. -
Add
#svg-octicon-mortar-board-16
to theocticons.html
sprite template. This icon is useful for linking to the document's citation. -
Export a variable,
T
fromtechnote.sphinxconf
that is an instance oftechnote.main.TechnoteSphinxConfig
. This is useful for organizations that need to access the technote configuration and metadata in their own technote theme. -
Figures and tables with captions are now numbered using the Sphinx
numfig
configuration. Authors can reference figures by number using thenumref
role pointing to the figure'sname
option. -
Authors are now listed below the title of the technote. This is a change from the previous behavior of listing authors in the sidebar.
Bug fixes
- Fix the
sidebar-authors.html
component template so that extra spaces aren't introduced between authors and commas.
What's Changed
- DM-41917: Improvements for theming by @jonathansick in #35
- DM-41917: Export TechnoteSphinxConfig instance from config by @jonathansick in #36
- DM-41917: Add authors to the main column of text by @jonathansick in #38
Full Changelog: 0.5.1...0.6.0