Skip to content

Commit

Permalink
Merge pull request projectmesa#737 from SebastianoF/DOC-correction-re…
Browse files Browse the repository at this point in the history
…adme-docs-for-mesa

Very quick changes in formatting the readme Docs markdown
  • Loading branch information
Corvince authored Oct 1, 2019
2 parents 91f2b84 + 42bbf4e commit 8e5b361
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,11 @@ The readable version of the docs is hosted at [mesa.readthedocs.org](http://mesa

This folder contains the docs that build the docs for the core mesa code on readthdocs.

###How to publish updates to the docs
### How to publish updates to the docs

Updating docs can be confusing. Here are the basic setups.

####Create the rST files from ipynb files
#### Create the rST files from ipynb files
1. Change to the appropriate directory (usually docs/tutorials)
* ```cd tutorials```
1. Create rST files using nbconvert
Expand All @@ -18,7 +18,7 @@ Updating docs can be confusing. Here are the basic setups.
* jupyter: `pip install jupyter`
* [pandoc](http://pandoc.org/installing.html)

#####Submit a pull request with updates
##### Submit a pull request with updates
1. Create branch (either via branching or fork of repo) -- try to use a descriptive name.
* ```git checkout -b doc-updates```
1. Update the docs. Save.
Expand All @@ -31,14 +31,14 @@ Updating docs can be confusing. Here are the basic setups.
* ```git push origin doc-updates```
1. From here you will want to submit a pull request to master.

#####Update read the docs
##### Update read the docs

From this point, you will need to find someone that has access to readthedocs. Currently, that is [@jackiekazil](https://github.com/jackiekazil) and [@dmasad](https://github.com/dmasad).

1. Accept the pull request into master.
1. Log into readthedocs and launch a new build -- builds take about 10 minutes or so.

###Helpful Sphnix tips
### Helpful Sphnix tips
* Build html from docs:
* ```make html```
* Autogenerate / update sphninx from docstrings (replace your name as the author:
Expand Down

0 comments on commit 8e5b361

Please sign in to comment.