Merge pull request #30 from mb-wali/docs

documentation

CONTRIBUTING.rst

@@ -10,7 +10,7 @@ Types of Contributions
 Report Bugs
 ~~~~~~~~~~~
 
-Report bugs at https://github.com/https://github.com/mb-wali/invenio-theme-tugraz.git/issues.
+Report bugs at https://github.com/mb-wali/invenio-theme-tugraz/issues.
 
 If you are reporting a bug, please include:
 
@@ -41,7 +41,7 @@ Submit Feedback
 ~~~~~~~~~~~~~~~
 
 The best way to send feedback is to file an issue at
-https://github.com/https://github.com/mb-wali/invenio-theme-tugraz.git/issues.
+https://github.com/mb-wali/invenio-theme-tugraz/issues.
 
 If you are proposing a feature:
 
@@ -114,5 +114,5 @@ Before you submit a pull request, check that it meets these guidelines:
 2. If the pull request adds functionality, the docs should be updated. Put
    your new functionality into a function with a docstring.
 3. The pull request should work for Python 2.7, 3.5 and 3.6. Check
-   https://travis-ci.org/https://github.com/mb-wali/invenio-theme-tugraz.git/pull_requests
+   https://travis-ci.com/github/mb-wali/invenio-theme-tugraz/pull_requests
    and make sure that the tests pass for all supported Python versions.

README.md

@@ -1,13 +0,0 @@
-# invenio-theme-tugraz
-invenio module for TUGRAZ theme.
-
-## install
-```pipenv install git+https://github.com/mb-wali/invenio-theme-tugraz.git@master#egg=invenio_theme_tugraz```
-
-## Developing
-While developing this module make sure to comment or remove these variables from ```invenio.cfg``` file.
-```
-THEME_LOGO="images/logo.svg"
-INSTANCE_THEME_FILE = './scss/<instance>/theme.scss'
-INSTANCE_SEARCH_THEME_FILE = './scss/<instance>/search/theme.scss'
-```

README.rst

@@ -1,5 +1,5 @@
 ..
-    Copyright (C) 2020 mojib wali.
+    Copyright (C) 2020 Mojib wali.
 
     invenio-theme-tugraz is free software; you can redistribute it and/or
     modify it under the terms of the MIT License; see LICENSE file for more
@@ -9,20 +9,11 @@
  invenio-theme-tugraz
 ======================
 
-.. image:: https://img.shields.io/travis/https://github.com/mb-wali/invenio-theme-tugraz.git.svg
-        :target: https://travis-ci.org/https://github.com/mb-wali/invenio-theme-tugraz.git
+.. image:: https://img.shields.io/travis/inveniosoftware/invenio-app-rdm.svg
+        :target: https://travis-ci.com/github/mb-wali/invenio-theme-tugraz
 
-.. image:: https://img.shields.io/coveralls/https://github.com/mb-wali/invenio-theme-tugraz.git.svg
-        :target: https://coveralls.io/r/https://github.com/mb-wali/invenio-theme-tugraz.git
-
-.. image:: https://img.shields.io/github/tag/https://github.com/mb-wali/invenio-theme-tugraz.git.svg
-        :target: https://github.com/https://github.com/mb-wali/invenio-theme-tugraz.git/releases
-
-.. image:: https://img.shields.io/pypi/dm/invenio-theme-tugraz.svg
-        :target: https://pypi.python.org/pypi/invenio-theme-tugraz
-
-.. image:: https://img.shields.io/github/license/https://github.com/mb-wali/invenio-theme-tugraz.git.svg
-        :target: https://github.com/https://github.com/mb-wali/invenio-theme-tugraz.git/blob/master/LICENSE
+.. image:: https://img.shields.io/github/license/inveniosoftware/invenio-app-rdm.svg
+        :target: https://github.com/mb-wali/invenio-theme-tugraz/blob/master/LICENSE
 
 invenio module for TUGRAZ theme.
 

docs/conf.py

@@ -123,7 +123,7 @@ html_theme_options = {
     'github_banner': True,
     'show_powered_by': False,
     'extra_nav_links': {
-        'invenio-theme-tugraz@GitHub': 'https://github.com/https://github.com/mb-wali/invenio-theme-tugraz.git',
+        'invenio-theme-tugraz@GitHub': 'https://github.com/mb-wali/invenio-theme-tugraz',
         'invenio-theme-tugraz@PyPI': 'https://pypi.python.org/pypi/invenio-theme-tugraz/',
     }
 }