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

Fix generating docs for Readthedocs #197

Merged
merged 1 commit into from Feb 27, 2021
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.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
11 changes: 11 additions & 0 deletions .readthedocs.yaml
@@ -0,0 +1,11 @@
---
version: 2

sphinx:
configuration: docs/conf.py
fail_on_warning: true

python:
version: 3.8
install:
- requirements: docs/requirements.txt
6 changes: 3 additions & 3 deletions CONTRIBUTING.md
Expand Up @@ -61,11 +61,11 @@ Documentation will automatically be rebuilt on every push thanks to the
Read The Docs webhook. You can [find it
here](https://pypuppetdb.readthedocs.org/en/latest/).

You can build the documentation manually by doing:
You can build the documentation locally by doing:

```bash
# Activate the virtualenv and install sphinx + the theme we are using
pip install sphinx sphinx-rtd-theme
# Activate the virtualenv used for the app development
pip install -r docs/requirements.txt
cd docs
make html
```
2 changes: 2 additions & 0 deletions docs/requirements.txt
@@ -0,0 +1,2 @@
sphinx
sphinx-rtd-theme
4 changes: 1 addition & 3 deletions pypuppetdb/types.py
Expand Up @@ -528,8 +528,6 @@ class Catalog(object):
corresponding report
:ivar edges: :obj:`list` of :obj:`Edge` The source Resource object\
of the relationship
:ivar resources: :obj:`dict` of :class:`pypuppetdb.types.Resource` The\
source Resource object of the relationship
:ivar environment: :obj:`string` Environment associated with the
catalog's certname
:ivar code_id: :obj:`string` ties the catalog to the Puppet code that\
Expand Down Expand Up @@ -608,7 +606,7 @@ class Edge(object):
:type source: :class:`pypuppetdb.Resource`
:param target: The target Resource object of the relationship
:type target: :class:`pypuppetdb.Resource`
:param relaptionship: Name of the Puppet Ressource Relationship
:param relationship: Name of the Puppet Resource Relationship
:type relationship: :obj:`string`
:param node: The certname of the node that owns this Relationship
:type node: :obj:`string`
Expand Down