Skip to content

Add more flexible documentation options#139

Merged
tiffanymtang merged 13 commits intomainfrom
improve-rmd-doc
Jan 10, 2023
Merged

Add more flexible documentation options#139
tiffanymtang merged 13 commits intomainfrom
improve-rmd-doc

Conversation

@tiffanymtang
Copy link
Copy Markdown
Collaborator

Address the following suggestions from @yanshuotan in issue #132:

  • Return the .Rmd file used in create_docs() to allow user to directly edit this .Rmd
  • Create a barebones option for the documentation file (e.g., return a raw markdown file with pointers to .png files for the visualizers and slots for the simulation documentation). This would be an alternative if the .html version is too big.
  • Consider adding wrapper function or convenient way to automatically save visualizer plots to .png/.jpg

@tiffanymtang tiffanymtang requested a review from jpdunc23 January 5, 2023 19:32
Copy link
Copy Markdown
Contributor

@jpdunc23 jpdunc23 left a comment

Choose a reason for hiding this comment

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

Looks good! These new features will be super handy.

I made some comments requesting specific changes and with some thoughts on API design, and it's fine by me if we don't fully address everything in this PR.

Ideally the changes for this PR are fairly quick and we can merge this in soon. But lmk if anything is more work than I realize and I'm happy to pitch in or we can put it off until later.

Comment thread R/docs.R Outdated
Comment thread R/docs.R Outdated
Comment thread R/docs.R Outdated
Comment thread R/experiment.R
Comment thread R/docs.R Outdated
Comment thread R/docs.R Outdated
Comment thread man/cross.Rd Outdated
Comment thread R/experiment.R
@tiffanymtang tiffanymtang merged commit 64bec15 into main Jan 10, 2023
@tiffanymtang tiffanymtang deleted the improve-rmd-doc branch January 10, 2023 21:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants