1.0.0rc2 (#30)

.github/workflows/github-pages.yml

@@ -0,0 +1,44 @@
+name: Deploy GitHub Pages
+
+on:
+  push:
+    branches:
+      - master
+      - develop
+  release:
+    types:
+      - published
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+jobs:
+  build-and-deploy:
+    runs-on: ubuntu-22.04
+    environment: github-pages
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.11'
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -r docs/source/requirements.txt
+      - name: Build documentation
+        run: |
+          cd docs
+          make html
+      - name: Disable Jekyll
+        run: |
+          touch docs/build/html/.nojekyll
+      - name: Upload pages artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: docs/build/html
+      - name: Deploy to GitHub Pages
+        uses: actions/deploy-pages@v4

README.md

@@ -1,11 +1,11 @@
 # PyRCS
 
 [![PyPI - Version](https://img.shields.io/pypi/v/pyrcs)](https://pypi.org/project/pyrcs/)
-[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/pyrcs)](https://www.python.org/downloads/)
+[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/pyrcs)](https://docs.python.org/3/)
 [![License](https://img.shields.io/github/license/mikeqfu/pyrcs)](https://github.com/mikeqfu/pyrcs/blob/master/LICENSE)
-[![Read the Docs - Documentation](https://readthedocs.org/projects/pyrcs/badge/?version=latest)](https://pyrcs.readthedocs.io/en/latest/?badge=latest)
+[![Read the Docs - Documentation](https://img.shields.io/readthedocs/pyrcs?logo=readthedocs)](https://pyrcs.readthedocs.io/en/latest/?badge=latest)
 [![Codacy - Code Quality](https://app.codacy.com/project/badge/Grade/7369679225b14eaeb92ba40c12c339d5)](https://app.codacy.com/gh/mikeqfu/pyrcs/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade)
-[![DOI](https://zenodo.org/badge/92501006.svg)](https://zenodo.org/badge/latestdoi/92501006)
+[![DOI](https://img.shields.io/badge/10.5281%2Fzenodo.4026744-blue?label=doi)](https://doi.org/10.5281/zenodo.4026744)
 
 PyRCS is an open-source Python package designed to simplify the collection and management of diverse codes used in different systems within the UK rail industry. It serves as a practical toolkit for researchers, practitioners, and individuals who frequently interact with the [Railway Codes](http://www.railwaycodes.org.uk/index.shtml) website and work extensively with railway codes in the UK. Leveraging the capabilities of the Python programming language, PyRCS enables efficient access to and manipulation of railway code data, enhancing productivity and effectiveness in working with these codes.
 

docs/source/index.rst

@@ -9,7 +9,7 @@ PyRCS
     :target: https://pypi.org/project/pyrcs/
 .. |PyPI - Python Version| image:: https://img.shields.io/pypi/pyversions/pyrcs
     :alt: PyPI - Python Version
-    :target: https://www.python.org/downloads/
+    :target: https://docs.python.org/3/
 .. |Read the Docs - Documentation| image:: https://img.shields.io/readthedocs/pyrcs?logo=readthedocs
     :alt: Read the Docs - Documentation
     :target: https://pyrcs.readthedocs.io/en/latest/?badge=latest

docs/source/use-of-data.rst

@@ -1,5 +1,5 @@
 ===========
-Use of data
+Use of Data
 ===========
 
-For the use of the data pre-packed with, and collected by, PyRCS, please refer to this link: http://www.railwaycodes.org.uk/misc/contributing.shtm
+For information on using the data pre-packaged with and collected by PyRCS, please refer to the `Use/Contribute <http://www.railwaycodes.org.uk/misc/contributing.shtm>`_ page.

pyrcs/data/.metadata

@@ -5,7 +5,7 @@
     "Author": "Qian Fu",
     "Affiliation": "School of Engineering, University of Birmingham",
     "Email": "q.fu@bham.ac.uk",
-    "Version": "1.0.0dev1",
+    "Version": "1.0.0",
     "License": "MIT License",
     "First release": "August 2019"
 }