From 3da0526cf850ea44f47556f6cd7e31bf721d01d5 Mon Sep 17 00:00:00 2001 From: "Sean J. Taylor" Date: Sat, 25 Feb 2017 18:26:06 -0800 Subject: [PATCH] Fix links to documentation. Add some notes about how to edit docs. --- docs/README.md | 11 +++++++++++ docs/_docs/contributing.md | 11 +++++++++++ docs/_includes/doc.html | 2 +- 3 files changed, 23 insertions(+), 1 deletion(-) diff --git a/docs/README.md b/docs/README.md index f00990d..65ce9b7 100644 --- a/docs/README.md +++ b/docs/README.md @@ -6,6 +6,17 @@ This directory will contain the user and feature documentation for Prophet. The See [CONTRIBUTING.md](./CONTRIBUTING.md) for details on how to add or modify content. +## Jupyter Notebooks + +Most of the `doc` pages are generated from [Jupyter notebooks](http://jupyter.org/) in the [notebooks](https://github.com/facebookincubator/prophet/tree/master/notebooks) directory at the base of the source tree. Please make changes there and then rebuild the docs: + +``` +$ cd docs +$ make notebooks +``` + +Make sure you have installed [rpy2](https://rpy2.bitbucket.io/) so that the R code can be run as well. + ### Run the Site Locally The requirements for running a GitHub pages site locally is described in [GitHub help](https://help.github.com/articles/setting-up-your-github-pages-site-locally-with-jekyll/#requirements). The steps below summarize these steps. diff --git a/docs/_docs/contributing.md b/docs/_docs/contributing.md index 7eb2547..5c33533 100644 --- a/docs/_docs/contributing.md +++ b/docs/_docs/contributing.md @@ -12,3 +12,14 @@ We appreciate all contributions. If you are planning to contribute back bug-fixe If you plan to contribute new features or extensions to the core, please first open an issue and discuss the feature with us. Sending a pull request is fine, too, but if it is a large change we suggest you run it by us first. We require that any API changes or feature additions are made available for both Python and R in parallel. + +## Documentation + +Most of the `doc` paages are generated from [Jupyter notebooks](http://jupyter.org/) in the [notebooks](https://github.com/facebookincubator/prophet/tree/master/notebooks) directory at the base of the source tree. Please make changes there and then rebuild the docs: + +``` +$ cd docs +$ make notebooks +``` + +Make sure you have installed [rpy2](https://rpy2.bitbucket.io/) so that the R code can be run as well. diff --git a/docs/_includes/doc.html b/docs/_includes/doc.html index 2205e89..a795000 100644 --- a/docs/_includes/doc.html +++ b/docs/_includes/doc.html @@ -18,7 +18,7 @@ {% else %} {{ content }} -

Edit on GitHub

+

Edit on GitHub

{% endif %} {% include doc_paging.html %}