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

RTD integration #96

Open
wants to merge 13 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 3 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
21 changes: 21 additions & 0 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# .readthedocs.yaml
# Read the Docs configuration file
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details

# Required
version: 2

# Set the version of Python and other tools you might need
build:
os: ubuntu-20.04
tools:
python: "3.9"

# Configure python
python:
install:
- requirements: docs/readthedocs/requirements.txt

# Build documentation in the docs/ directory with Sphinx
sphinx:
configuration: docs/readthedocs/conf.py
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ the whole area.
|vertical levels | 60 level |
|upper boundary | 22.5km |

![](doc/img/icon-eu-nest.png)
![](docs/readthedocs/_static/img/icon-eu-nest.png)


In contrast, the converter area can be set in the code to the area of interest.
Expand All @@ -88,7 +88,7 @@ In the future it would make sense to provide the
coordinates via a config file instead of hard-coding them into the binary.
If you want to provide this future feel free to hand in an issue or a pull request.

![](doc/img/converter_covered_area.jpg)
![](docs/readthedocs/_static/img/converter_covered_area.jpg)


### Requirements
Expand Down
1 change: 1 addition & 0 deletions build.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ plugins {
id 'com.github.onslip.gradle-one-jar' version '1.0.6' // pack a self contained jar
id 'jacoco' // java code coverage plugin
id "org.sonarqube" version "3.3" // sonarqube
id "kr.motd.sphinx" version "2.10.0"
}

ext {
Expand Down
20 changes: 20 additions & 0 deletions docs/readthedocs/Makefile
Original file line number Diff line number Diff line change
@@ -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 ?= python3 -msphinx
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)
Binary file not shown.
Binary file added docs/readthedocs/_build/doctrees/index.doctree
Binary file not shown.
Binary file not shown.
Binary file not shown.
4 changes: 4 additions & 0 deletions docs/readthedocs/_build/html/.buildinfo
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: 7548f94c04a1bc11a0b7faf47e2f7b2c
tags: 645f666f9bcd5a90fca523b33c5a78b7
30 changes: 30 additions & 0 deletions docs/readthedocs/_build/html/_sources/index.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
Documentation of the DWDTools
=========================================

Hello weather!

.. toctree::
:maxdepth: 2
:caption: Contents:

user/test
user/users



Contact the (Main) Maintainers
------------------------------
If you feel, something this missing, wrong or misleading, please contact one of our main contributors:

* `@sensarmad <https://github.com/sensarmad>`_
* `@johanneshiry <https://github.com/johanneshiry>`_
* `@ckittl <https://github.com/ckittl>`_

Hat tip to all other contributors!

Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
1 change: 1 addition & 0 deletions docs/readthedocs/_build/html/_sources/user/test.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
sflöehspg
3 changes: 3 additions & 0 deletions docs/readthedocs/_build/html/_sources/user/users.md.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Users Guide

You got this!
Loading