Skip to content

feat: Small updates for ReadTheDocs integration #96

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.

Sign up for GitHub

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

Merged
merged 3 commits into from
May 12, 2022
Merged

feat: Small updates for ReadTheDocs integration #96

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
464f78d
Add Readthedocs badge to README
bgrant May 12, 2022
ebdd6d7
Nicer title to docs
bgrant May 12, 2022
a11c700
CHANGELOG update
bgrant May 12, 2022
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
1 change: 1 addition & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ Versioning](https://semver.org/spec/v2.0.0.html).

# [unreleased] - YYYY-MM-DD
### Added
- [PR 96](https://github.com/salesforce/django-declarative-apis/pull/96) Minor tweaks for ReadTheDocs integration
- [PR 94](https://github.com/salesforce/django-declarative-apis/pull/94) Add a Pull Request template/checklist to the repo
- [PR 92](https://github.com/salesforce/django-declarative-apis/pull/92) Run tests and static analysis as a PR check using GitHub actions
- [PR 83](https://github.com/salesforce/django-declarative-apis/pull/83) Allow Django 3
Expand Down
5 changes: 3 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
[![Documentation Status](https://readthedocs.org/projects/django-declarative-apis/badge/?version=stable)](https://django-declarative-apis.readthedocs.io/en/stable/?badge=stable)


Overview
========

Expand All @@ -11,8 +14,6 @@ django-declarative-apis is a framework built on top of Django aimed at teams imp
- Separation of concerns between request body processing and business logic




Quick start
===========

Expand Down
4 changes: 2 additions & 2 deletions docs/source/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.

Welcome to django-declarative-apis's documentation!
===================================================
Django Declarative APIs v\ |version|
====================================

.. include:: overview.rst

Expand Down