README.md (prophet-1.0) | : | README.md (prophet-1.1) | ||
---|---|---|---|---|
## User Documentation for Prophet | ## User Documentation for Prophet | |||
This directory will contain the user and feature documentation for Prophet. The documentation will be hosted on GitHub pages. | This directory will contain the user and feature documentation for Prophet. The documentation will be hosted on GitHub pages. | |||
### Contributing | ### Contributing | |||
See [CONTRIBUTING.md](./CONTRIBUTING.md) for details on how to add or modify con tent. | See [CONTRIBUTING.md](./CONTRIBUTING.md) for details on how to add or modify con tent. | |||
## Jupyter Notebooks | ## Jupyter Notebooks | |||
Most of the `doc` pages are generated from [Jupyter notebooks](http://jupyter.or g/) in the [notebooks](https://github.com/facebook/prophet/tree/master/notebooks ) directory at the base of the source tree. Please make changes there and then rebuild the docs: | Most of the `doc` pages are generated from [Jupyter notebooks](http://jupyter.or g/) in the [notebooks](https://github.com/facebook/prophet/tree/main/notebooks) directory at the base of the source tree. Please make changes there and then re build the docs: | |||
``` | ``` | |||
$ cd docs | $ cd docs | |||
$ make notebooks | $ make notebooks | |||
``` | ``` | |||
Make sure you have installed [rpy2](https://rpy2.bitbucket.io/) so that the R co de can be run as well. | Make sure you have installed [rpy2](https://rpy2.bitbucket.io/) so that the R co de can be run as well. | |||
### Run the Site Locally | ### 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-locall y-with-jekyll/#requirements). The steps below summarize these steps. | 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-locall y-with-jekyll/#requirements). The steps below summarize these steps. | |||
> If you have run the site before, you can start with step 1 and then move on to step 5. | > If you have run the site before, you can start with step 1 and then move on to step 5. | |||
1. Ensure that you are in the same directory where this `README.md` exists (e.g. , it could be in `/docs` on `master`, in the root of a `gh-pages` branch, etc). The below RubyGems commands, etc must be run from there. | 1. Ensure that you are in the same directory where this `README.md` exists (e.g. , it could be in `/docs` on `main`, in the root of a `gh-pages` branch, etc). Th e below RubyGems commands, etc must be run from there. | |||
1. Make sure you have Ruby and [RubyGems](https://rubygems.org/) installed. | 1. Make sure you have Ruby and [RubyGems](https://rubygems.org/) installed. | |||
> Ruby >= 2.2 is required for the gems. On the latest versions of Mac OS X, R uby 2.0 is the | > Ruby >= 2.2 is required for the gems. On the latest versions of Mac OS X, R uby 2.0 is the | |||
> default. Use [Homebrew](http://brew.sh) and the `brew install ruby` command (or your | > default. Use [Homebrew](http://brew.sh) and the `brew install ruby` command (or your | |||
> preferred upgrade mechanism) to install a newer version of Ruby for your Ma c OS X system. | > preferred upgrade mechanism) to install a newer version of Ruby for your Ma c OS X system. | |||
1. Make sure you have [Bundler](http://bundler.io/) installed. | 1. Make sure you have [Bundler](http://bundler.io/) installed. | |||
``` | ``` | |||
End of changes. 2 change blocks. | ||||
2 lines changed or deleted | 2 lines changed or added |