Update docs

ScholCommLab · Apr 6, 2021 · 7ceb7a4 · 7ceb7a4
1 parent 458ee38
commit 7ceb7a4
Show file tree

Hide file tree

Showing 6 changed files with 13 additions and 15 deletions.
diff --git a/app/__init__.py b/app/__init__.py
@@ -14,4 +14,5 @@
 __license__ = "MIT License"
 __version__ = "0.1.0"
 __url__ = "https://github.com/ScholCommLab/fhe-collector"
+__project__ = "FHE Collector"
 __description__ = "Facebook Hidden Engagement Microservice"
diff --git a/app/docs/source/_templates/sidebar_intro.html b/app/docs/source/_templates/sidebar_intro.html
@@ -1,7 +1,7 @@
 <h1 class="logo"><a href="{{ pathto(master_doc) }}">{{ project }}</a></h1>
 
 <p>{{ theme_description }}</p>
-<p>Developed by the <a hre="https://www.scholcommlab.ca/">Simon Fraser University - Scholarly Communication Lab</a>.</p>
+<p>Developed by the <a href="https://www.scholcommlab.ca/" title="Simon Fraser University - Scholarly Communication Lab">Simon Fraser University - Scholarly Communication Lab</a>.</p>
 
 <p>
   <a class="badge" href="https://travis-ci.com/ScholCommLab/fhe-collector">

diff --git a/app/docs/source/_templates/sidebar_related-links.html b/app/docs/source/_templates/sidebar_related-links.html
@@ -1,8 +1,8 @@
 <h3>Useful Links</h3>
 <ul>
-  <li><a href="https://github.com/ScholCommLab/fhe-collector">GitHub</a></li>
-  <li><a href="https://github.com/ScholCommLab/fhe-collector/issues">Issue Tracker</a></li>
-  <li><a hre="https://www.scholcommlab.ca/">Simon Fraser University - Scholarly Communication Lab</a></li>
-  <li><a href="https://stefankasberger.at">Stefan Kasberger</a></li>
-  <li><a href="https://github.com/Bubblbu">Asura Enkhbayar</a></li>
+  <li><a href="https://github.com/ScholCommLab/fhe-collector" title="GitHub fhe-collector">GitHub</a></li>
+  <li><a href="https://github.com/ScholCommLab/fhe-collector/issues" title="GitHub fhe-collector Issues">Issue Tracker</a></li>
+  <li><a href="https://www.scholcommlab.ca/" title="Simon Fraser University - Scholarly Communication Lab">Simon Fraser University - Scholarly Communication Lab</a></li>
+  <li><a href="https://stefankasberger.at" title="Stefan Kasberger">Stefan Kasberger</a></li>
+  <li><a href="https://github.com/Bubblbu" title="Asura Enkhbayar">Asura Enkhbayar</a></li>
 </ul>
diff --git a/app/docs/source/conf.py b/app/docs/source/conf.py
@@ -23,7 +23,7 @@
 
 # -- Project information -----------------------------------------------------
 
-project = app.__name__
+project = app.__project__
 copyright = app.__copyright__
 author = app.__author__
 description = app.__description__

diff --git a/app/docs/source/index.rst b/app/docs/source/index.rst
@@ -78,7 +78,7 @@ Install
 
 .. code-block:: shell
 
-    pip install fhe-collector
+    pip install fhe_collector
 
 
 Find more options at :ref:`user_installation`.
@@ -170,22 +170,18 @@ Open Source projects in general live from the cooperation of the many and it's p
 standing on the shoulders of so many contributors, so to say thanks is the
 least that can be done.
 
-FHE Collector is funded by Simon Fraser University - `Scholarly Communication Lab <https://www.scholcommlab.ca/>`_
+FHE Collector is funded by `Simon Fraser University - Scholarly Communication Lab <https://www.scholcommlab.ca/>`_
 
 
 .. _homepage_license:
 
 License
 -----------------------------
 
-Copyright Stefan Kasberger and others, 2018.
+Copyright Stefan Kasberger and others, 2021.
 
 Distributed under the terms of the MIT license, FHE Collector is free and open source software.
 
 Full License Text: `LICENSE.txt <https://github.com/ScholCommLab/fhe-collector/blob/master/LICENSE.txt>`_
 
 The documentation is licensed under `CC BY 4.0 <https://creativecommons.org/licenses/by/4.0/>`_.
-
-.. toctree::
-   :maxdepth: 2
-   :caption: Contents:
diff --git a/app/docs/source/user/resources.rst b/app/docs/source/user/resources.rst
@@ -12,13 +12,14 @@ FHE Collector
 - Working document for the integration of Facebook-OJS into CED: (`GDoc <https://docs.google.com/document/d/10gjV8A8UgDOOM52ByTsaAvgzqLZtC2b6c_pnDEzBraI/edit?usp=sharing>`_))
 - Code base for collecting URLs and engagement: `fhe-plos <https://github.com/ScholCommLab/fhe-plos>`_
 - Facebook Graph API
+
   - `Docs <https://facebook-sdk.readthedocs.io/en/latest/api.html>`_
   - Request `URL /?id={url} <https://developers.facebook.com/docs/graph-api/reference/v3.2/url>`_
   - `Graph API restrictions <https://newsroom.fb.com/news/2018/04/restricting-data-access/>`_
   - `Rate limiting <https://developers.facebook.com/docs/graph-api/advanced/rate-limiting/>`_
   - `Debug <https://developers.facebook.com/tools/debug/>`_
   - `Explorer <https://developers.facebook.com/tools/explorer/>`_
-  - Python module: `facebook-sdk <https://facebook-sdk.readthedocs.io/`> (`API Reference <https://facebook-sdk.readthedocs.io/en/latest/api.html>`_)
+  - Python module: `facebook-sdk <https://facebook-sdk.readthedocs.io/>`_ (`API Reference <https://facebook-sdk.readthedocs.io/en/latest/api.html>`_)
 
 
 .. _user_resources_literature: