javh/markr

markr's Issues

Proper documentation

Original report by me.

---

The package needs proper man pages and a vignette. Can use the docs for the package itself as a bootstrap theme example, and use alakazam as the readthedocs theme example.

Remove messages from CITATION parsing

Original report by me.

---

Parsing of the CITATION file includes the following in the output and should be removed:

To see these entries in BibTeX format, use ‘print(, bibtex=TRUE)’, ‘toBibtex(.)’, or set ‘options(citation.bibtex.max=999)’.

Maybe change documentation forward location

Original report by me.

---

See r-lib/pkgdown#113

Parse describe list as definition list

Original report by me.

---

Parsing \describe{} into a definition list would probably be cleaner, such as for Slots sections of S4 class man pages.

Review staticdocs

Original report by me.

---

There was a flurry of activity on the staticdocs repo the week of 8/22/16 (literally hundreds of notifications). Need to review the package before moving forward with a redesign of the parsing method.

Start with this?
r-lib/pkgdown#125 (comment)

Update install instructions to use github

Current install command in README is:

devtools::install_bitbucket("javh/markr@default")

Get \code{\link{}} to work

Original report by me.

---

Get \code{\link{}} to parse correctly somehow, probably via a pre- or post-conversion regex replacement.

Remove HTML generation

Original report by me.

---

Remove all the HTML generation. No longer needed.

Redesign as.sd_package

Original report by me.

---

as.sd_package() currently is designed to support HTML conversion. Needs some fiddling to avoid unnecessary steps to make it amenable to markdown conversion.

devtools version mismatch

Original report by nima nouri (Bitbucket: nimanouri, GitHub: nimanouri).

---

It seems the 'dev_meta' is not available after version '1.13.6' (most recent version is 2.0.1)

Generate Release Notes page

Original report by me.

---

A a Release Notes page from the NEWS.md file. Probably just by copying the file and adding it to the default mkdocs.yml.