Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add an explicit config for building readthedocs #43

Merged
merged 1 commit into from
Jul 14, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
# Config for building https://python-nitrate.readthedocs.io/
version: 2
build:
os: ubuntu-22.04
tools:
python: "3"
6 changes: 3 additions & 3 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ PACKAGE = python-nitrate-$(VERSION)
DOCS = $(TMP)/$(PACKAGE)/docs
EXAMPLES = $(TMP)/$(PACKAGE)/examples
CSS = --stylesheet=style.css --link-stylesheet
FILES = LICENSE README \
FILES = LICENSE README.rst \
Makefile python-nitrate.spec setup.py \
docs examples source

Expand All @@ -22,8 +22,8 @@ all: push clean
build:
mkdir -p $(TMP)/{SOURCES,$(PACKAGE)}
cp -a $(FILES) $(TMP)/$(PACKAGE)
rst2man README | gzip > $(DOCS)/python-nitrate.1.gz
rst2html README $(CSS) > $(DOCS)/index.html
rst2man README.rst | gzip > $(DOCS)/python-nitrate.1.gz
rst2html README.rst $(CSS) > $(DOCS)/index.html
rst2man $(DOCS)/notes.rst | gzip > $(DOCS)/nitrate-notes.1.gz
rst2html $(DOCS)/notes.rst $(CSS) > $(DOCS)/notes.html
rst2man $(DOCS)/nitrate.rst | gzip > $(DOCS)/nitrate.1.gz
Expand Down
File renamed without changes.
1 change: 1 addition & 0 deletions docs/index.rst
2 changes: 1 addition & 1 deletion python-nitrate.spec
Original file line number Diff line number Diff line change
Expand Up @@ -122,7 +122,7 @@ pathfix.py -pni "%{__python3} %{py3_shbang_opts}i" %{buildroot}%{_bindir}/nitrat
%{python3_sitelib}/nitrate-*.egg-info/
%{_mandir}/man1/*
%{_bindir}/nitrate
%doc README examples
%doc README.rst examples
%license LICENSE

%changelog
Expand Down
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

# Prepare short and long description
description = 'Python API for the Nitrate test case management system'
with open("README") as readme:
with open("README.rst") as readme:
long_description = readme.read()

# Parse version from the spec file
Expand Down