Skip to content

Commit 5f3e107

Browse files
author
Devyn Stott
committed
docs(): Rename and refactor things so they are better
1 parent 7b5a1b9 commit 5f3e107

File tree

9 files changed

+24
-62
lines changed

9 files changed

+24
-62
lines changed

README.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@ A starting spot for python projects. Embracing open source elements.
33

44
[![Documentation status](https://readthedocs.org/projects/python-starter/badge/?version=latest)](http://python-starter.readthedocs.io/en/latest/) [![Build Status](https://travis-ci.org/SyntaxRules/python-starter.svg?branch=master)](https://travis-ci.org/SyntaxRules/python-starter) [![codecov](https://codecov.io/gh/SyntaxRules/python-starter/branch/master/graph/badge.svg)](https://codecov.io/gh/SyntaxRules/python-starter)
55

6+
Documentation: http://python-starter.readthedocs.io/en/latest/
67

78
# Project Details
89

@@ -14,7 +15,7 @@ This project follows the structure suggested in [Jan-Philip Gehrcke's Blog](http
1415

1516
This project uses [Semver](http://semver.org/) as its versioning scheme.
1617

17-
## Tests.
18+
## Tests
1819

1920
Basic acceptance tests are in the tests folder. You can run these tests by running `python setup.py test`. The unit tests are in line with the code. You can run all the tests with `python -m pytest .`.
2021

@@ -25,3 +26,9 @@ Coverage is also determined by TravisCI and reported to [CodeCov](https://codeco
2526
## Documentation
2627

2728
Documentation is inline (like unit tests) and deployed with [Read the Docs](http://python-starter.readthedocs.io/en/latest/). When editing code, please include documentation for your changes. Add any new files to the `mkdocs.yml` file. The documentation is automatically built and installed.
29+
30+
The documentation is found here: http://python-starter.readthedocs.io/en/latest/
31+
32+
You can test the docs locally by installing [mkdocs](http://www.mkdocs.org/) and running `mkdocs serve` in the root directory of the project source. This will launch a server locally that you can use to view what the docs will look like when deployed. The pages update automatically when changes are made.
33+
34+
You can add a page to the documentation by editing the *mkdocs.yml* file in the source repo. See [Adding Pages](http://www.mkdocs.org/#adding-pages).

mkdocs.yml

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,5 +5,6 @@ docs_dir: 'starter'
55
pages:
66
- 'Overview': 'index.md'
77
- 'User Guide':
8-
- 'Quick Start': 'docs/user_guide/article1.md'
9-
- 'Service API': 'docs/user_guide/article2.md'
8+
- 'Quick Start': 'docs/quick-start.md'
9+
- 'Installation Instructions': 'docs/installation-instructions.md'
10+
- 'License': 'docs/license.md'

starter/README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Starter source and documentation
2+
3+
The source code for the documentation page is found in index.md (in this same directory).
4+
5+
The source code for this repo is found in this folder. See the docs for more information.

starter/docs/README.md

Lines changed: 0 additions & 51 deletions
This file was deleted.
Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Installation instructions
2+
3+
This section covers advanced installations instructions, including how to build from source.

starter/docs/quick-start.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Quick Start
2+
3+
To get started using this project:

starter/docs/user_guide/article1.md

Lines changed: 0 additions & 3 deletions
This file was deleted.

starter/docs/user_guide/article2.md

Lines changed: 0 additions & 3 deletions
This file was deleted.

starter/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# Overview
22

3-
This is the project overview
3+
This is the overview page and the default index page of the documentation.
44

5-
Wit foo bar
5+
For development details (i.e project structure, tests and versioning) see the README.md file in the src repository.

0 commit comments

Comments
 (0)