Skip to content

Commit

Permalink
fix directions (dotnet#1733)
Browse files Browse the repository at this point in the history
Add an optional extended description…
  • Loading branch information
Rick-Anderson authored Jul 28, 2016
1 parent c2bac00 commit c47e736
Showing 1 changed file with 19 additions and 23 deletions.
42 changes: 19 additions & 23 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -11,47 +11,43 @@ The documentation is built using [Sphinx](http://sphinx-doc.org) and [reStructur

Once you have cloned the Docs to your local machine, the following instructions will walk you through installing the tools necessary to build and test.

1. [Download python](https://www.python.org/downloads/) version 2.7.10 or higher (Version 3.4 is recommended).
1. [Download python](https://www.python.org/downloads/) version 2.7.10 or higher (Version 3.5 is recommended). If you install 3.5, check the include python in path option.

2. If you are installing on Windows, ensure both the Python install directory and the Python scripts directory have been added to your `PATH` environment variable. For example, if you install Python into the c:\python34 directory, you would add `c:\python34;c:\python34\scripts` to your `PATH` environment variable.
2. Skip this step if you installed python 3.5 and checked the "include in python path" option. If you are installing on Windows, ensure both the Python install directory and the Python scripts directory have been added to your `PATH` environment variable. For example, if you install Python into the c:\python34 directory, you would add `c:\python34;c:\python34\scripts` to your `PATH` environment variable.

3. Install Sphinx by opening a command prompt and running the following Python command. (Note that this operation might take a few minutes to complete.)
3. Clone the docs:

```pip install sphinx```

4. By default, when you install Sphinx, it will install the ReadTheDocs custom theme automatically. If you need to update the installed version of this theme, you should run:

```pip install -U sphinx_rtd_theme```
```git clone https://github.com/aspnet/Docs.git```

4. Navigate to the Docs repo and install the build dependencies:

5. Install the Sphinx .NET domain:
```cd docs```

```pip install sphinxcontrib-dotnetdomain```

6. Navigate to one of the main project subdirectories in the Docs repo - such as `mvc`, `aspnet`, or `webhooks`.
```pip install -r requirements.txt```


**Note**: You might need to run this command from Power Shell.

5. Navigate to the *aspnet* directory and run ``make`` (make.bat on Windows, Makefile on Mac/Linux)

7. Run ``make`` (make.bat on Windows, Makefile on Mac/Linux)
```cd aspnet```

```make html```
```make html ```

8. Once make completes, the generated docs will be in the .../docs/<project>/_build/html directory. Simply open the `index.html` file in your browser to see the built docs for that project.
6. Once make completes, the generated docs will be in the .../docs/<project>/_build/html directory. Open the `index.html` file in your browser to see the built docs for that project. ``make livehtml`` is recommended, see the next section.

## Use autobuild to easily view site changes locally ##

You can also install [sphinx-autobuild](https://github.com/GaretJax/sphinx-autobuild) which will run a local web server and automatically refresh whenever changes to the source files are detected. To do so:

1. Install sphinx-autobuild

```pip install sphinx-autobuild```

2. Navigate to one of the main project subdirectories in the Docs repo - such as `mvc`, `aspnet`, or `webhooks`.

3. Run ``make`` (make.bat on Windows, Makefile on Mac/Linux)
1. Run ``make livehtml`` (make.bat on Windows, Makefile on Mac/Linux) from the *aspnet* directory

```make livehtml```

4. Browse to `http://127.0.0.1:8000` to see the locally built documentation.
2. Browse to `http://127.0.0.1:8000` to see the locally built documentation.

5. Hit `^C` to stop the local server.
3. Hit `^C` to stop the local server.

## Adding Content ##

0 comments on commit c47e736

Please sign in to comment.