Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
thombashi committed Jan 11, 2019
1 parent a5861e7 commit 2f1b5ab
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 7 deletions.
5 changes: 2 additions & 3 deletions README.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
**typepy**

.. contents:: Table of Contents
.. contents:: **typepy**
:backlinks: top
:depth: 2

Summary
Expand Down
11 changes: 8 additions & 3 deletions docs/make_readme.py
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@

import sys

import readmemaker
from readmemaker import ReadmeMaker


PROJECT_NAME = "typepy"
Expand All @@ -23,7 +23,12 @@ def write_examples(maker):


def main():
maker = readmemaker.ReadmeMaker(PROJECT_NAME, OUTPUT_DIR, is_make_toc=True)
maker = ReadmeMaker(
PROJECT_NAME,
OUTPUT_DIR,
is_make_toc=True,
project_url="https://github.com/thombashi/{}".format(PROJECT_NAME),
)

maker.write_chapter("Summary")
maker.write_introduction_file("summary.txt")
Expand All @@ -38,7 +43,7 @@ def main():

maker.set_indent_level(0)
maker.write_chapter("Documentation")
maker.write_line_list(["https://{:s}.rtfd.io/".format(PROJECT_NAME)])
maker.write_lines(["https://{:s}.rtfd.io/".format(PROJECT_NAME)])

return 0

Expand Down
2 changes: 1 addition & 1 deletion requirements/docs_requirements.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
path.py
readmemaker>=0.6.1,<1.0.0
readmemaker>=0.7.3,<1.0.0
sphinx_rtd_theme
Sphinx

0 comments on commit 2f1b5ab

Please sign in to comment.