updating README and CHANGELOG

2020-03-08 21:32:44 +00:00
parent f2145d8cdc
commit 509cd86830
8 changed files with 146 additions and 50 deletions
--- a/docs/source/changelog.rst
+++ b/docs/source/changelog.rst
@@ -1,21 +1 @@
-Changelog
-==========
-
-All notable changes to this project will be documented in this file.
-
-This format is based on `Keep a Changelog`_ 
-
-.. _Keep a Changelog: https://keepachangelog.com/en/1.0.0/
-
-and this project adheres to `Semantic Versioning`_ 
-
-.. _Semantic Versioning: https://semver.org/spec/v2.0.0.html
-
-
-[1.0.0] - 2020-03-07
------------------------
-
-Added
-######
-
- Initial version
+.. include:: ../../CHANGELOG.rst
--- a/docs/source/conf.py
+++ b/docs/source/conf.py
@@ -39,7 +39,8 @@ extensions = [
    'sphinx.ext.napoleon',
    'sphinx.ext.todo',
    'sphinx_click.ext',
-    'sphinx.ext.intersphinx'
+    'sphinx.ext.intersphinx',
+    'sphinx.ext.autosectionlabel'
 ]

 # -- Napoleon Settings -----------------------------------------------------
--- a/docs/source/introduction.rst
+++ b/docs/source/introduction.rst
@@ -1,13 +1 @@
-=============
-Introduction
-=============
-
-#####
-Test
-#####
-
-testing
-
-test code::
-
-    some test code
+.. include:: ../../README.rst
--- a/docs/source/modules/musicbrainzapi.api.lyrics.director.rst
+++ b/docs/source/modules/musicbrainzapi.api.lyrics.director.rst
@@ -1,5 +1,5 @@
 musicbrainzapi.api.lyrics.director
----------------------------------------------------------------------------------
+-------------------------------------

 .. automodule:: musicbrainzapi.api.lyrics.director
   :members: