Commit Graph

49 Commits

Author SHA1 Message Date
Matt Riedemann
c6bd48f0fa Remove reference to building conda env from yml file
Since the guide isn't using the environment.yml file anymore
it doesn't make a lot of sense to link to a doc about building
a conda environment from a yml file.
2020-09-11 11:41:29 -05:00
Matt Riedemann
d45a46ad54 Use docs extra for building docs instructions
With the `docs` install extra in setup.py we can simplify the
setup for building the docs by avoiding the now redundant
docs/doc-requirements.txt and docs/environment.yml.
One change is needed in setup.py though which is to add the
`sphinx-rtd-theme` package to the setup.py `docs` extra install
package list which was in doc-requirements.txt and environment.yml
but missing from setup.py.
2020-09-11 11:34:41 -05:00
Matt Riedemann
503d5e7569 Also pip install the notebook for building docs via conda env
To build the docs you need the notebook package installed from
the local project so this updates the contributor guide for the
conda instructions.

Related #5741
2020-09-11 08:56:42 -05:00
Matt Riedemann
b7b600952e Make sure notebook is pip installed when building docs
The instructions on building the docs fail to mention that
the notebook package itself needs to be installed. I was following
the pip-based instructions so this fixes that case. I'm not familiar
with using conda really so that case isn't fixed here.

Partial #5741
2020-09-10 09:03:19 -05:00
Koki Nishihara
a8522bb0f2
Fix link to Project Jupyter Documentation Guide 2020-07-12 00:11:37 +09:00
Koki Nishihara
ff509cc42a
Fix broken links
The link to the `Project Jupyter Documentation Guide` is broken.
Fixed it links.
2020-07-11 07:54:49 +09:00
Thomas Kluyver
2eb5544358
Merge pull request #4899 from rayehh/master
Add end punctuation and update korean document
2019-11-27 12:19:46 +00:00
Kerwin.Sun
6adddaa61e fix doc about pip install with test extra require 2019-10-02 00:54:31 +08:00
Yeonseong Hwang
ddf0025fc6 Add end punctuation and update korean document
Signed-off-by: Yeonseong Hwang <ysh099@gmail.com>
2019-09-19 09:14:11 +09:00
hdtee1
9daeffb668
Update CONTRIBUTING.rst 2019-07-13 07:11:52 -10:00
Madicken Munk
f9d578ee40 add pytest to test env requirements and suggest it in contributing docs 2018-07-20 16:52:21 -05:00
danagilliann
ee3710139b complete section on troubleshooting the installation 2018-04-27 14:02:49 -04:00
danagilliann
7b60c679e4 attempt to render image 2018-04-26 13:27:30 -04:00
danagilliann
1c1202cc7f made pull request changes 2018-04-26 13:25:24 -04:00
danagilliann
1b70075b07 text improvements 2018-04-22 22:48:39 -04:00
Rosa Swaby
b13a7915e5 made changes to formatting of verificaton sectiom 2018-04-13 17:48:40 -04:00
Rosa Swaby
9291806062 trying new forma for adding image 2018-04-13 17:39:19 -04:00
Rosa Swaby
7565b4829c trying to add image to verification section 2018-04-13 17:22:37 -04:00
Rosa Swaby
64c576a5c0 changing image link 2018-04-10 12:11:38 -04:00
Rosa Swaby
5b64339453 instead of using screenshot i am now using the link to the image 2018-04-10 12:02:27 -04:00
Rosa Swaby
cfca135dd6 deleyting old screenshot and using screenshot that was used in the issue 2018-04-10 12:00:42 -04:00
Rosa Swaby
b21ec3a7c0 adding image to doc 2018-04-10 11:53:16 -04:00
Rosa Swaby
29447f79c6 adding screenshot to show dev mode 2018-04-10 11:50:21 -04:00
Rosa Swaby
e2e9c40d20 fixing merge conflict with troubleshoot section 2018-04-10 11:48:10 -04:00
danagilliann
76b474a729 remove whitespace above "Troubleshooting" 2018-04-10 11:46:04 -04:00
danagilliann
f334d6bd84 Merge branch 'documentation' of github.com:nyu-ossd-s18/notebook into documentation 2018-04-10 11:40:22 -04:00
danagilliann
44a775bc95 added troubleshooting steps 2018-04-10 11:40:08 -04:00
Rosa Swaby
d736b2efd7 making doc changes for verification portion of documentation 2018-04-10 11:38:02 -04:00
Vidar Tonaas Fauske
f6de61d34e Fix some broken links and permanent redirects 2017-09-01 13:09:51 +02:00
Min RK
885ebc3eba invert --user recommendation in CONTRIBUTING
make `--user` the non-default option,
given the prevalence of conda/virtual envs these days
2017-03-17 12:08:28 +01:00
Min RK
f57b92d3c0 update nodejs installation instructions
remove reference to `nodejs-legacy`, since apt packages are usually too old, anyway
2017-03-17 12:06:12 +01:00
Louise Davies
8014f1c15f Updated docs on installed phantomjs 2017-02-27 15:57:40 +00:00
Grant Nestor
674ac624d0 Update dev install/build docs 2017-02-13 15:57:08 -08:00
Adam Chainz
a947025308 Convert readthedocs links for their .org -> .io migration for hosted projects
As per [their blog post of the 27th April](https://blog.readthedocs.com/securing-subdomains/) ‘Securing subdomains’:

> Starting today, Read the Docs will start hosting projects from subdomains on the domain readthedocs.io, instead of on readthedocs.org. This change addresses some security concerns around site cookies while hosting user generated data on the same domain as our dashboard.

Test Plan: Manually visited all the links I’ve modified.
2016-10-09 21:56:18 +01:00
Carol Willing
f2f916315c Edits to correct rst errors found by doc8 2016-10-02 14:44:02 -07:00
Stuart Geiger
cad19f86bf Add info on how to launch master branch install 2016-07-16 08:26:01 -07:00
Carol Willing
3fb49c795d Remove general install link 2016-07-05 21:35:11 -07:00
Peter Parente
d6e81fef15 Note that pandoc is required for doc 2016-07-05 11:10:52 -04:00
Carol Willing
4362f03227 Update link to Contributor guides 2016-06-11 04:42:42 -07:00
Carol Willing
fcbe6b52df Update ReadTheDocs link in CONTRIBUTING file 2016-06-07 13:08:58 -07:00
Carol Willing
ce610d11ef Minor file name changes 2016-03-24 15:13:48 -07:00
Matthias Geier
69b09b5af0 Add instructions for getting the doc-building requirements
... and add docs/requirements.txt
2016-03-24 18:48:23 +01:00
Matthias Geier
3c1fcedfaa Re-order the node/npm section
And add the conda command provided by @damianavila.
2016-03-19 14:37:58 +01:00
Matthias Geier
b6a2d81e1e Add a welcoming sentence suggested by @willingc 2016-03-19 14:24:08 +01:00
Matthias Geier
13a81daf94 Remove section about Python Development Libs 2016-03-15 15:38:31 +01:00
Matthias Geier
60f1aa14ea Re-order installation instructions 2016-03-15 15:28:08 +01:00
Matthias Geier
daedb4da79 Add more information about building the docs 2016-03-15 15:15:33 +01:00
Matthias Geier
8ae254de85 Some improvements suggested by @willingc
See #1208.
2016-03-15 14:32:49 +01:00
Matthias Geier
ac89707ecc DOC: Trying to make a single place for contributor docs
See #1193.
2016-03-14 20:21:27 +01:00