Skip to content

Commit

Permalink
Render the dev-guide as part of pkgdown (#771)
Browse files Browse the repository at this point in the history
* Render the dev-guide as part of pkgdown

* Fix rendering
  • Loading branch information
cicdguy authored Nov 1, 2023
1 parent 3b8ed50 commit 0c6f7b7
Show file tree
Hide file tree
Showing 26 changed files with 54 additions and 15,452 deletions.
1 change: 1 addition & 0 deletions .Rbuildignore
Original file line number Diff line number Diff line change
Expand Up @@ -26,3 +26,4 @@
^staged_dependencies\.yaml$
^temp$
~$
^vignettes/dev-guide$
56 changes: 40 additions & 16 deletions _pkgdown.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,20 +14,40 @@ navbar:
dev-guide:
text: Developer Guide
menu:
# Go to *REF1* below in this config and add any
# additional topics that you may add here,
# as you need to do so due to a pkgdown limitation.
- text: Split Machinery
href: ../inst/dev-guide/dg_split_machinery.html
href: articles/dev-guide/dg_split_machinery.html
- text: Tabulation
href: ../inst/dev-guide/dg_tabulation.html
href: articles/dev-guide/dg_tabulation.html
- text: Debugging in {rtables} and Beyond
href: ../inst/dev-guide/dg_debug_rtables.html
href: articles/dev-guide/dg_debug_rtables.html

repo:
url:
home: https://github.com/insightsengineering/rtables/
source: https://github.com/insightsengineering/rtables/blob/main/
issue: https://github.com/insightsengineering/rtables/issues/
user: https://github.com/
news:
cran_dates: true

authors:
before: "We define *authors* as those who are actively maintaining the code base, and *contributors* as those who made a significant contribution in the past. For all acknowledgements, see the eponymous section in the [Home Page](https://insightsengineering.github.io/rtables/)."
footer:
roles: [aut, ctb, cre, fnd]
text: "Developed by"
sidebar:
roles: [aut]

articles:
- title: Getting Started
navbar: Getting Started
contents:
- introduction
- exploratory_analysis

- title: Clinical Trials
navbar: Clinical Trials
contents:
Expand All @@ -40,23 +60,27 @@ articles:
- custom_appearance
- title_footer
- sorting_pruning

- title: \{rtables\} Concepts
contents:
- subsetting_tables
- split_functions
- format_precedence
- tabulation_concepts
- tabulation_concepts

- title: Advanced Usage
contents:
- advanced_usage
- example_analysis_coxreg

- title: Other
contents:
- manual_table_construction
- tabulation_dplyr
# *REF1* Dev Guide items
- 'dev-guide/dg_split_machinery'
- 'dev-guide/dg_tabulation'
- 'dev-guide/dg_debug_rtables'

reference:
- title: Argument Conventions
Expand All @@ -67,7 +91,7 @@ reference:
- compat_args
- gen_args
- sf_args

- title: Layout and Tabulation
desc: Functions for declaring layout and tabulation
contents:
Expand All @@ -83,7 +107,7 @@ reference:
- split_cols_by_multivar
- split_rows_by_multivar
- analyze_colvars
- split_cols_by_cuts
- split_cols_by_cuts
- add_overall_col
- add_existing_table
- formatters::table_inset
Expand All @@ -99,7 +123,7 @@ reference:
- spl_context
- spl_context_to_disp_path
- counts_wpcts

- title: Split Functions
contents:
- add_overall_level
Expand Down Expand Up @@ -128,7 +152,7 @@ reference:
contents:
- format_rcell
- value_formats

- title: Table Structure Information
contents:
- dim,VTableNodeInfo-method
Expand Down Expand Up @@ -160,7 +184,7 @@ reference:
- validate_table_struct
- sanitize_table_struct
- find_degen_struct

- title: Sorting and Pruning
contents:
- prune_table
Expand All @@ -169,9 +193,9 @@ reference:
- trim_rows
- sort_at_path
- cont_n_allcols

- title: Compatibility Layer
desc: These functions provide some backwards compatibility to the previous
desc: These functions provide some backwards compatibility to the previous
(pre 2021) `rtables` framework.
contents:
- rtable
Expand All @@ -182,8 +206,8 @@ reference:
- rrowl
- indent
- df_to_tt


- title: Output Functions
desc: These functions create ascii or html representations of the table
contents:
Expand Down
Binary file removed inst/.DS_Store
Binary file not shown.
Binary file removed inst/bootstrap/.DS_Store
Binary file not shown.
Loading

0 comments on commit 0c6f7b7

Please sign in to comment.