Skip to content

Commit a1ccf3b

Browse files
author
Devyn Stott
committed
doc(): testing new docs, Round 5
1 parent f67de4b commit a1ccf3b

File tree

9 files changed

+24
-5
lines changed

9 files changed

+24
-5
lines changed

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
# python-starter
22
A starting spot for python projects. Embracing open source elements.
33

4+
![Documentation status](https://readthedocs.org/projects/python-starter/badge/?version=latest)
5+
46
# Project Structure
57

68
This project follows the structure suggested in [Jan-Philip Gehrcke's Blog](https://gehrcke.de/2014/02/distributing-a-python-command-line-application/).

mkdocs.yml

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
11
site_name: Python-Starter
22
repo_url: https://github.com/SyntaxRules/python-starter/
3+
theme: readthedocs
4+
docs_dir: 'starter'
35
pages:
4-
- 'Home': 'overview.md'
6+
- 'Overview': 'README.md'
57
- 'User Guide':
6-
- 'Quick Start': 'article1.md'
7-
- 'Service API': 'article2.md'
8+
- 'Quick Start': 'docs/user_guide/article1.md'
9+
- 'Service API': 'docs/user_guide/article2.md'
Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
11
# Overview
22

33
This is the project overview
4+
5+
Wit foo bar

docs/README.md renamed to starter/docs/README.md

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,19 @@
1-
# Welcome to MkDocs
1+
# Documentation
2+
3+
The documentation uses [mkdocs.org](http://mkdocs.org) to build and serve itself. This produces pretty HTML pages for external viewing and is compatible with ReadtheDocs.org.
4+
5+
To generate a PDF of this documentation use: https://github.com/jgrassler/mkdocs-pandoc
6+
7+
## Generating a PDF
8+
9+
To generate a PDF from mkdocs use [mkdocs-pandoc](https://github.com/jgrassler/mkdocs-pandoc).
10+
11+
To install it, perform the following steps:
12+
13+
1. yum install fonts-lmodern lmodern pandoc texlive-base texlive-latex-extra texlive-fonts-recommended texlive-latex-recommended texlive-xetex
14+
2. yum install texlive-latex texlive-pdfpages texlive-pdftex
15+
216

3-
For full documentation visit [mkdocs.org](http://mkdocs.org).
417

518
## Commands
619

starter/docs/__init__.py

Whitespace-only changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

0 commit comments

Comments
 (0)