#57 add baseline docs structure to package - WIP no fxns

CHANGELOG.md

@@ -10,7 +10,7 @@ Scribe-Data tries to follow [semantic versioning](https://semver.org/), a MAJOR.
 
 Emojis for the following are chosen based on [gitmoji](https://gitmoji.dev/).
 
-# [Upcoming] Scribe-Data 3.2.0
+## [Upcoming] Scribe-Data 3.2.0
 
 ### ✨ Features
 
@@ -34,7 +34,7 @@ Emojis for the following are chosen based on [gitmoji](https://gitmoji.dev/).
 
 - Tensorflow was removed from the download wiki process to fix build problems on Macs.
 
-# Scribe-Data 3.1.0
+## Scribe-Data 3.1.0
 
 ### ✨ Features
 
@@ -47,7 +47,7 @@ Emojis for the following are chosen based on [gitmoji](https://gitmoji.dev/).
 
 - Database output column names are now zero indexed to better align with Python and other language standards.
 
-# Scribe-Data 3.0.0
+## Scribe-Data 3.0.0
 
 ### ✨ Features
 
@@ -79,7 +79,7 @@ Emojis for the following are chosen based on [gitmoji](https://gitmoji.dev/).
 
 - The statements in translation files have been fixed as they were improperly defined after a file was moved.
 
-# Scribe-Data 2.2.2
+## Scribe-Data 2.2.2
 
 ### ✨ Features
 
@@ -89,26 +89,26 @@ Emojis for the following are chosen based on [gitmoji](https://gitmoji.dev/).
 
 - The export filenames for emoji keywords were renamed to reflect their usage in autosuggestions and soon autocompletions as well.
 
-# Scribe-Data 2.2.1
+## Scribe-Data 2.2.1
 
 ### ✨ Features
 
 - The number of suggested emojis for words can now be limited.
 - The total number of emojis that suggestions can be made for can now be limited.
 
-# Scribe-Data 2.2.0
+## Scribe-Data 2.2.0
 
 ### ✨ Features
 
 - Scribe-Data now allows the user to create JSONs of word-emoji key-value pairs ([#24](https://github.com/scribe-org/Scribe-Data/issues/24)).
 
-# Scribe-Data 2.1.0
+## Scribe-Data 2.1.0
 
 ### ✨ Features
 
 - Scribe-Data can now split Wikidata queries into multiple stages to break up those that were too large to run ([#21](https://github.com/scribe-org/Scribe-Data/issues/21)).
 
-# Scribe-Data 2.0.0
+## Scribe-Data 2.0.0
 
 ### ✨ Features
 
@@ -122,7 +122,7 @@ Emojis for the following are chosen based on [gitmoji](https://gitmoji.dev/).
 
 - The error messages for incorrect args in update_data.py have been updated.
 
-# Scribe-Data 1.0.1
+## Scribe-Data 1.0.1
 
 ### ✨ Features
 
@@ -134,7 +134,7 @@ Emojis for the following are chosen based on [gitmoji](https://gitmoji.dev/).
 - Hard coded strings for Spanish formatting files were fixed.
 - The paths of update_data.py were changed to match the new package structure.
 
-# Scribe-Data 1.0.0
+## Scribe-Data 1.0.0
 
 ### 🚀 Deployment
 

CONTRIBUTING.md

@@ -10,7 +10,7 @@ If you have questions or would like to communicate with the team, please [join u
 
 <a id="contents"></a>
 
-# **Contents**
+## **Contents**
 
 - [First steps as a contributor](#first-steps)
 - [Learning the tech stack](#learning-the-tech)
@@ -67,7 +67,7 @@ Scribe is very open to contributions from people in the early stages of their co
 
 <a id="dev-env"></a>
 
-# Development environment [`⇧`](#contents)
+## Development environment [`⇧`](#contents)
 
 The development environment for Scribe-Data can be installed via the following steps:
 
@@ -114,7 +114,7 @@ git remote add upstream https://github.com/scribe-org/Scibe-Data.git
 
 <a id="issues-projects"></a>
 
-# Issues and projects [`⇧`](#contents)
+## Issues and projects [`⇧`](#contents)
 
 The [issue tracker for Scribe-Data](https://github.com/scribe-org/Scribe-Data/issues) is the preferred channel for [bug reports](#bug-reports), [features requests](#feature-requests) and [submitting pull requests](#pull-requests). Scribe also organizes related issues into [projects](https://github.com/scribe-org/Scribe-Data/projects).
 
@@ -125,7 +125,7 @@ Be sure to check the [`-next release-`](https://github.com/scribe-org/Scribe-Dat
 
 <a id="bug-reports"></a>
 
-# Bug reports [`⇧`](#contents)
+## Bug reports [`⇧`](#contents)
 
 A bug is a _demonstrable problem_ that is caused by the code in the repository. Good bug reports are extremely helpful - thank you!
 
@@ -151,13 +151,13 @@ Again, thank you for your time in reporting issues!
 
 <a id="feature-requests"></a>
 
-# Feature requests [`⇧`](#contents)
+## Feature requests [`⇧`](#contents)
 
 Feature requests are more than welcome! Please take a moment to find out whether your idea fits with the scope and aims of the project. When making a suggestion, provide as much detail and context as possible, and further make clear the degree to which you would like to contribute in its development. Feature requests are marked with the [`feature`](https://github.com/scribe-org/Scribe-Data/issues?q=is%3Aopen+is%3Aissue+label%3Afeature) label, and can be made using the [feature request](https://github.com/scribe-org/Scribe-Data/issues/new?assignees=&labels=feature&template=feature_request.yml) template.
 
 <a id="pull-requests"></a>
 
-# Pull requests [`⇧`](#contents)
+## Pull requests [`⇧`](#contents)
 
 Good pull requests - patches, improvements and new features - are the foundation of our community making Scribe-Data. They should remain focused in scope and avoid containing unrelated commits. Note that all contributions to this project will be made under [the specified license](https://github.com/scribe-org/Scribe-Data/blob/main/LICENSE.txt) and should follow the coding indentation and style standards ([contact us](https://matrix.to/#/#scribe_community:matrix.org) if unsure).
 
@@ -204,7 +204,7 @@ Thank you in advance for your contributions!
 
 <a id="data-edits"></a>
 
-# Data edits [`⇧`](#contents)
+## Data edits [`⇧`](#contents)
 
 > [!NOTE]\
 > Please see the [Wikidata and Scribe Guide](https://github.com/scribe-org/Organization/blob/main/WIKIDATAGUIDE.md) for an overview of [Wikidata](https://www.wikidata.org/) and how Scribe uses it.
@@ -213,6 +213,6 @@ Scribe does not accept direct edits to the grammar JSON files as they are source
 
 <a id="documentation"></a>
 
-# Documentation [`⇧`](#contents)
+## Documentation [`⇧`](#contents)
 
 Documentation is an invaluable way to contribute to coding projects as it allows others to more easily understand the project structure and contribute. Issues related to documentation are marked with the [`documentation`](https://github.com/scribe-org/Scribe-Data/labels/documentation) label.

README.md

@@ -2,7 +2,8 @@
   <a href="https://github.com/scribe-org/Scribe-Data"><img src="https://raw.githubusercontent.com/scribe-org/Scribe-Data/main/.github/resources/images/ScribeDataLogo.png" height=150 alt="Scribe Logo"></a>
 </div>
 
-[![platforms](https://img.shields.io/badge/Wikidata-990000.svg?logo=wikidata&logoColor=ffffff)](https://github.com/scribe-org/Scribe-Data)
+[![rtd](https://img.shields.io/readthedocs/scribe-data.svg?logo=read-the-docs)](http://scribe-data.readthedocs.io/en/latest/)
+[![platform](https://img.shields.io/badge/Wikidata-990000.svg?logo=wikidata&logoColor=ffffff)](https://github.com/scribe-org/Scribe-Data)
 [![issues](https://img.shields.io/github/issues/scribe-org/Scribe-Data?label=%20&logo=github)](https://github.com/scribe-org/Scribe-Data/issues)
 [![language](https://img.shields.io/badge/Python%203-306998.svg?logo=python&logoColor=ffffff)](https://github.com/scribe-org/Scribe-Data/blob/main/CONTRIBUTING.md)
 [![pypi](https://img.shields.io/pypi/v/scribe-data.svg?label=%20&color=4B8BBE)](https://pypi.org/project/scribe-data/)

docs/Makefile

@@ -0,0 +1,19 @@
+# Minimal makefile for Sphinx documentation
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = source
+BUILDDIR      = build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/make.bat

@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=source
+set BUILDDIR=build
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.http://sphinx-doc.org/
+	exit /b 1
+)
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd

docs/requirements.txt

@@ -0,0 +1,5 @@
+m2r2
+numpydoc
+scribe-data
+sphinx<7.0.0
+sphinx_rtd_theme