Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
TROUVERIE Joachim committed Apr 23, 2018
1 parent abbee16 commit 7a14138
Show file tree
Hide file tree
Showing 4 changed files with 16 additions and 80 deletions.
1 change: 0 additions & 1 deletion docs/REQUIREMENTS.txt

This file was deleted.

12 changes: 7 additions & 5 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,9 @@
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
#
# import os
# import sys
# sys.path.insert(0, os.path.abspath('.'))
import os
import sys
sys.path.insert(0, os.path.abspath('..'))


# -- Project information -----------------------------------------------------
Expand Down Expand Up @@ -76,7 +76,7 @@
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
#
html_theme = 'flask'
html_theme = 'alabaster'

html_context = {
"css_files": ["_static/index.css"]
Expand All @@ -87,7 +87,9 @@
# documentation.
#
html_theme_options = {
"github_fork": "j0ack/pybeeryaml",
'github_user': 'j0ack',
'github_repo': 'pybeeryaml',
'github_banner': True
}

# Add any paths that contain custom static files (such as style sheets) here,
Expand Down
13 changes: 9 additions & 4 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,20 @@ PyBeerYAML

|pyversion| |version| |license| |travis|

A YAML format parser for beer storage.
A Python YAML format parser for beer storage.

Parse a recipe from a YAML file and returns an object containing ingredients and
metadata. Supports export to `beerxml <http://beerxml.com/>`_ format.
Parse a recipe from a `beeryaml <http://beeryaml.rtfd.io/>`_ file and returns
an object containing ingredients and metadata. Supports export to
`beerxml <http://beerxml.io/>`_ format.

For more information about the beeryaml format please read the following
documentation:

http://beeryaml.rtfd.io/

.. toctree::
:maxdepth: 1

yaml_format
quickstart
contribute
api/pybeeryaml
Expand Down
70 changes: 0 additions & 70 deletions docs/yaml_format.rst

This file was deleted.

0 comments on commit 7a14138

Please sign in to comment.