https://github.com/sahilseth/readthedocs
Create readthedocs website for a R package
https://github.com/sahilseth/readthedocs
Last synced: 4 months ago
JSON representation
Create readthedocs website for a R package
- Host: GitHub
- URL: https://github.com/sahilseth/readthedocs
- Owner: sahilseth
- License: other
- Created: 2015-07-24T16:26:50.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2015-08-25T21:22:06.000Z (over 9 years ago)
- Last Synced: 2024-08-13T07:12:46.936Z (8 months ago)
- Language: R
- Size: 134 KB
- Stars: 5
- Watchers: 2
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- jimsghstars - sahilseth/readthedocs - Create readthedocs website for a R package (R)
README
# RTD
A wrapper around [staticdocs](https://github.com/hadley/staticdocs) providing a way to port R documentation into a
[readthedocs](https://github.com/hadley/staticdocs) flavored website.
See here for an [example](docs.flowr.space).
## Features:
- Sphnix/readthedocs provides a convinient way to produce a beautiful, searchable and
powerful website.
- Further, Sphinx provides an excellent ( and powerful ) tree structure for organizing the docs
- this packages, makes it easy to convert all markdown vignettes and R help files to ReSt format
- Thus, one can use Markdown, but still use the power of ReadTheDocs (Sphinx).
```R
# install.packages("devtools")
devtools::install_github("sahilseth/readthedocs")
```
```R
library(staticdocs)
librar(readthedocs)
require(tools)
outwd = "flowrdocs/source/rd" ## assuming sphnix reads from the source directory
pkg = staticdocs::as.sd_package(pkg = ".",
site_path = outwd,
templates_path = system.file("templates", package = "readthedocs"))
tmp <- build_topics(pkg = pkg)
tmp <- build_vignettes(pkg = pkg)
```
Then one needs to call sphnix to build the website locally OR update this to github and point readthedocs.org to it.
Refer to [readthedocs](https://readthedocs.org) for more information regarding this setup.