Преглед на файлове

Fix links to documentation.
Add some notes about how to edit docs.

Sean J. Taylor преди 8 години
родител
ревизия
3da0526cf8
променени са 3 файла, в които са добавени 23 реда и са изтрити 1 реда
  1. 11 0
      docs/README.md
  2. 11 0
      docs/_docs/contributing.md
  3. 1 1
      docs/_includes/doc.html

+ 11 - 0
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.
 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
 ### 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.
 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.

+ 11 - 0
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.
 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.
 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.

+ 1 - 1
docs/_includes/doc.html

@@ -18,7 +18,7 @@
     {% else %}
     {% else %}
       {{ content }}
       {{ content }}
 
 
-      <p><a class="edit-page-link" href="https://github.com/{{ site.ghrepo }}/tree/gh-pages/{{ page.path }}" target="_blank">Edit on GitHub</a></p>
+      <p><a class="edit-page-link" href="https://github.com/{{ site.ghrepo }}/blob/master/docs/{{ page.path }}" target="_blank">Edit on GitHub</a></p>
     {% endif %}
     {% endif %}
   </article>
   </article>
   {% include doc_paging.html %}
   {% include doc_paging.html %}