Skip to content

Commit eac46bc

Browse files
committed
Prepping for Github Pages
1 parent 33c27ea commit eac46bc

File tree

9 files changed

+9
-7
lines changed

9 files changed

+9
-7
lines changed

Diff for: .readthedocs.yml

+2-2
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,9 @@
55
# Required
66
version: 2
77

8-
# Build documentation in the docs/ directory with Sphinx
8+
# Build documentation in the api_docs/ directory with Sphinx
99
sphinx:
10-
configuration: docs/conf.py
10+
configuration: api_docs/conf.py
1111

1212
# Build documentation with MkDocs
1313
#mkdocs:

Diff for: docs/.gitignore renamed to api_docs/.gitignore

File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

Diff for: docs/conf.py renamed to api_docs/conf.py

File renamed without changes.

Diff for: docs/index.rst renamed to api_docs/index.rst

File renamed without changes.

Diff for: web/README.md renamed to docs/README.md

File renamed without changes.

Diff for: generate_docs.sh

+7-5
Original file line numberDiff line numberDiff line change
@@ -4,18 +4,20 @@
44
# Generate API documentation for the Text_extensions for pandas package
55
# using Sphinx.
66
#
7-
# To make adjustments to the landing page, edit the index.rst file in the docs directory
8-
# To make adjustments to the style or change settings, modify the conf.py in the docs directory
7+
# To make adjustments to the landing page, edit the index.rst file in the
8+
# api_docs directory
9+
# To make adjustments to the style or change settings, modify the conf.py in the
10+
# api_docs directory
911
#
1012
# This script is made to run using the same python environment as is used for the package
1113
# and should be run accordingly
1214

1315
# Clean up the results of previous runs
14-
rm -rf docs/_build/html
16+
rm -rf api_docs/_build/html
1517

1618
# Old code to remove the outputs of Sphinx autoapi; no longer needed
17-
#find docs -not -name 'index.rst' -name '*.rst' -delete
19+
#find api_docs -not -name 'index.rst' -name '*.rst' -delete
1820

1921
# Invoke Sphinx
20-
sphinx-build -b html docs docs/_build/html
22+
sphinx-build -b html api_docs api_docs/_build/html
2123

0 commit comments

Comments
 (0)