Skip to content

Commit

Permalink
Change CSS from nowrap to collapse in function arguments (#308)
Browse files Browse the repository at this point in the history
  • Loading branch information
etiennebacher authored Feb 26, 2025
1 parent b1ff5b4 commit 6d264b5
Show file tree
Hide file tree
Showing 5 changed files with 395 additions and 387 deletions.
84 changes: 46 additions & 38 deletions NEWS.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,13 @@
# News

## development version

### Changes

* The CSS for arguments table in "Reference" page has changed a bit. Argument
names are now wrapped so that they have limited width, improving the
readibility in case of multiple arguments on the same line (#308).

## 0.5.0

### Breaking changes
Expand All @@ -8,7 +16,7 @@

### Other changes

* `README.qmd` is no longer required to create a `quarto_website`, only
* `README.qmd` is no longer required to create a `quarto_website`, only
`README.md` (#295).

### Bug fixes
Expand All @@ -31,15 +39,15 @@
### New features
* `render_docs(freeze = TRUE)` now works correctly when output is `"quarto_website"`.
Freezing a document needs to be set either at a project or per-file level. To do
Freezing a document needs to be set either at a project or per-file level. To do
so, add to either `quarto_website.yml` or the frontmatter of a file:

``` yml
execute:
freeze: auto
```
* For Quarto websites, `render_docs()` can use the `downlit` package to automatically
link function calls to their documentation on the web. Turn off by modifying
link function calls to their documentation on the web. Turn off by modifying
the `code-link` line in `altdoc/quarto_website.yml`
* Citation is now formatted with HTML instead of verbatim (#282, Achim Zeileis).
* The `\doi{}` tags in Rd files are now linked once rendered (#282, Achim Zeileis).
Expand All @@ -54,22 +62,22 @@

## 0.3.0

All functions have changed so any change listed below technically is a breaking
All functions have changed so any change listed below technically is a breaking
change.


### Breaking changes

* Functions renamed:
- `use_docute()`, `use_docsify()` and `use_mkdocs()` are combined into `setup_docs()`
- `use_docute()`, `use_docsify()` and `use_mkdocs()` are combined into `setup_docs()`
- `update_docs()` -> `render_docs()`
- `preview()` -> `preview_docs()`
* `setup_docs()` (previously `use_*()`) no longer updates and previews the website

* `setup_docs()` (previously `use_*()`) no longer updates and previews the website
by default.
* `custom_reference` argument is removed. See the `Post-processing` vignette for
* `custom_reference` argument is removed. See the `Post-processing` vignette for
a description of the new proposed workflow.
* `theme` argument is removed. Users can change themes by editing settings files
* `theme` argument is removed. Users can change themes by editing settings files
in `altdoc/`
* `mkdocs` documentation is no longer stored in `docs/docs/`

Expand All @@ -79,30 +87,30 @@ change.

* Support Quarto vignettes (.qmd) in the `vignettes/` folder.

* `render_docs(parallel = TRUE)` uses `future` to parallelize the rendering of
* `render_docs(parallel = TRUE)` uses `future` to parallelize the rendering of
vignettes and man pages.

* `render_docs(freeze = TRUE)` no longer renders vignettes or man pages when they
have not changed and are already stored in `docs/`.

* Link to source code at the top of function reference.

* Settings files are now permanently stored in the `altdoc/` directory. These
* Settings files are now permanently stored in the `altdoc/` directory. These
files can be edited manually to customize the website.
* Major internal changes to the .Rd -> .md conversion system. We now use Quarto
to convert man pages and execute examples, and the man pages are stored in

* Major internal changes to the .Rd -> .md conversion system. We now use Quarto
to convert man pages and execute examples, and the man pages are stored in
separate markdown files instead of combined in a single large file.
* `mkdocs` now behaves like the other documentation generators and stores its
files in `docs/`. This means that `mkdocs` websites can be deployed to Github

* `mkdocs` now behaves like the other documentation generators and stores its
files in `docs/`. This means that `mkdocs` websites can be deployed to Github
Pages.

* Improved vignettes

* Do not reformat markdown header levels automatically, but raise a warning when
* Do not reformat markdown header levels automatically, but raise a warning when
there is more than one level 1 header.

* Fewer dependencies.
* Fix parsing for issue/PR references like [org/repo#111].

Expand All @@ -117,45 +125,45 @@ change.

## 0.2.2

* If necessary, two spaces are automatically added in nested lists in the `NEWS`
(or `Changelog`) file.
* If necessary, two spaces are automatically added in nested lists in the `NEWS`
(or `Changelog`) file.

* This is the last release before a large rework of this package.

## 0.2.1

* Fix test failures on CRAN due to the new version of `usethis`
* Fix test failures on CRAN due to the new version of `usethis`
(see https://github.com/cynkra/fledge/issues/683).

## 0.2.0
## 0.2.0

#### Breaking changes

* Vignettes are no longer automatically added to the file that defines the structure
of the website. Developers must now manually update this structure and the order
of their articles. Note that the name of the file defining the structure of the
of their articles. Note that the name of the file defining the structure of the
website differs based on the selected site builder. This file lives at the root
of `/docs` (`use_docsify()` = `_sidebar.md`; `use_docute()` = `index.html`;
of `/docs` (`use_docsify()` = `_sidebar.md`; `use_docute()` = `index.html`;
`use_mkdocs()` = `mkdocs.yml`).


#### Major changes
* `update_docs()` now updates the package version as well as altdoc version in

* `update_docs()` now updates the package version as well as altdoc version in
the footer.

* The NEWS or Changelog file included in the docs now automatically links issues,
pull requests and users (only works for projects on Github).

* Vignettes are now always rendered by `use_*()` or `update_docs()`. Therefore,
the argument `convert_vignettes` is removed. Previously, they were only rendered
if their content changed. This was problematic because the code in a vignette
the argument `convert_vignettes` is removed. Previously, they were only rendered
if their content changed. This was problematic because the code in a vignette
can have different output while the vignette in itself doesn't change (#37, #38).

* New argument `custom_reference` in `use_*()` and `update_docs()`. If it is a
path to a custom R file then it uses this file to build the "Reference" section
in the docs (#35).

#### Minor changes

* Fix some CRAN failures.
Expand Down
2 changes: 1 addition & 1 deletion R/rd2qmd.R
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
idx <- idx[seq_along(idx) %% 2 == 1]
tmp[idx] <- sub(
"<td>",
'<td style = "white-space: nowrap; font-family: monospace; vertical-align: top">',
'<td style = "white-space: collapse; font-family: monospace; vertical-align: top">',
tmp[idx]
)

Expand Down
Loading

0 comments on commit 6d264b5

Please sign in to comment.