Merge #191

191: docs r=andrewgsavage a=andrewgsavage - [ ] Closes # (insert issue number) - [ ] Executed `pre-commit run --all-files` with no errors - [ ] The change is fully covered by automated unit tests - [ ] Documented in docs/ as appropriate - [ ] Added an entry to the CHANGES file https://pint-pandas.readthedocs.io/en/docs/ Co-authored-by: Andrew <andrewgsavage@gmail.com> Co-authored-by: andrewgsavage <andrewgsavage@gmail.com>
hgrecco · Sep 5, 2023 · 068ded0 · 068ded0
2 parents c43c18b + 19322e5
commit 068ded0
Show file tree

Hide file tree

Showing 22 changed files with 855 additions and 1 deletion.
diff --git a/.gitignore b/.gitignore
@@ -4,6 +4,7 @@ __pycache__
 *.pyc
 .DS_Store
 docs/_build/
+docs/savefig/
 .idea
 .vscode
 build/

diff --git a/.readthedocs.yaml b/.readthedocs.yaml
@@ -0,0 +1,14 @@
+version: 2
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.9"
+sphinx:
+  configuration: docs/conf.py
+  fail_on_warning: false
+python:
+   install:
+     - requirements: requirements_docs.txt
+     - method: pip
+       path: .
+   system_packages: false
diff --git a/CHANGES b/CHANGES
@@ -4,7 +4,7 @@ pint-pandas Changelog
 0.5 (unreleased)
 ----------------
 
-<<<<<<< HEAD
+- ReadTheDocs Documentation created.
 - Support for Pandas version 2.1.0. #196
 - Support for dtype-preserving `PintArray.map` for both Pandas 2.0.2 and Pandas 2.1. #196
 - Support for <NA> values in columns with integer magnitudes

diff --git a/docs/Makefile b/docs/Makefile
@@ -0,0 +1,20 @@
+# 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     = .
+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)
diff --git a/docs/_static/index_api.svg b/docs/_static/index_api.svg
diff --git a/docs/_static/index_contribute.svg b/docs/_static/index_contribute.svg
diff --git a/docs/_static/index_getting_started.svg b/docs/_static/index_getting_started.svg
diff --git a/docs/_static/index_user_guide.svg b/docs/_static/index_user_guide.svg
diff --git a/docs/_static/logo-full.jpg b/docs/_static/logo-full.jpg
diff --git a/docs/_static/style.css b/docs/_static/style.css
@@ -0,0 +1,45 @@
+@import url('https://fonts.googleapis.com/css2?family=Lato:ital,wght@0,400;0,700;0,900;1,400;1,700;1,900&family=Open+Sans:ital,wght@0,400;0,600;1,400;1,600&display=swap');
+
+body {
+  font-family: 'Open Sans', sans-serif;
+}
+
+h1 {
+  font-family: "Lato", sans-serif;
+}
+
+pre, code {
+  font-size: 100%;
+  line-height: 155%;
+}
+
+/* Main page overview cards */
+
+.sd-card {
+  border-radius: 0;
+  padding: 30px 10px 20px 10px;
+  margin: 10px 0px;
+}
+
+.sd-card .sd-card-header {
+  text-align: center;
+}
+
+.sd-card .sd-card-header .sd-card-text {
+  margin: 0px;
+}
+
+.sd-card .sd-card-img-top {
+  height: 52px;
+  width: 52px;
+  margin-left: auto;
+  margin-right: auto;
+}
+
+.sd-card .sd-card-header {
+  border: none;
+  color: #150458 !important;
+  font-size: var(--pst-font-size-h5);
+  font-weight: bold;
+  padding: 2.5rem 0rem 0.5rem 0rem;
+}