Skip to content

Commit

Permalink
Justify section contents in documentation (#657)
Browse files Browse the repository at this point in the history
* remove tests already present in v3

Signed-off-by: F.N. Claessen <felix@seita.nl>

* move asset deletion test to v3

Signed-off-by: F.N. Claessen <felix@seita.nl>

* move asset creation test to v3

Signed-off-by: F.N. Claessen <felix@seita.nl>

* remove last remaining asset test from v2

Signed-off-by: F.N. Claessen <felix@seita.nl>

* stop testing post_price_data and post_prognosis on v2

Signed-off-by: F.N. Claessen <felix@seita.nl>

* move test scheduling with unknown prices from v1.3 to v3

Signed-off-by: F.N. Claessen <felix@seita.nl>

* remove v1.3 test already present in v3

Signed-off-by: F.N. Claessen <felix@seita.nl>

* move test for wrong job id from v1.3 to v3

Signed-off-by: F.N. Claessen <felix@seita.nl>

* no tests worth moving in v1.2

Signed-off-by: F.N. Claessen <felix@seita.nl>

* remove test for posting weather data from v1.1

Signed-off-by: F.N. Claessen <felix@seita.nl>

* move test for posting data with incompatible resolution from v1.1 to v3

Signed-off-by: F.N. Claessen <felix@seita.nl>

* move test for posting data with a user that is not properly set up as a data source, from v1.1 to v3; also test posting is not allowed for inactive admins

Signed-off-by: F.N. Claessen <felix@seita.nl>

* move test for getting data for an empty period from v1.1 to v3

Signed-off-by: F.N. Claessen <felix@seita.nl>

* move v3 tests that just GET data to test module that uses db fixture rather than fresh_db fixture

Signed-off-by: F.N. Claessen <felix@seita.nl>

* remove v1.1 test utils including old simulation script that uses one of them

Signed-off-by: F.N. Claessen <felix@seita.nl>

* salvage only 1 test from v1, which logs out a user

Signed-off-by: F.N. Claessen <felix@seita.nl>

* add missing fixtures to let tests succeed on their own, too

Signed-off-by: F.N. Claessen <felix@seita.nl>

* remove v1.0 test utils

Signed-off-by: F.N. Claessen <felix@seita.nl>

* add changelog warning

Signed-off-by: F.N. Claessen <felix@seita.nl>

* update API documentation

Signed-off-by: F.N. Claessen <felix@seita.nl>

* Document public endpoints in v3

Signed-off-by: F.N. Claessen <felix@seita.nl>

* black

Signed-off-by: F.N. Claessen <felix@seita.nl>

* Implement getService for API v3

Signed-off-by: F.N. Claessen <felix@seita.nl>

* Document service listing for v3

Signed-off-by: F.N. Claessen <felix@seita.nl>

* Show quickref contents rather than summary line of docstring

Signed-off-by: F.N. Claessen <felix@seita.nl>

* Fix removal of suffix and prefix, by not using rstrip and lstrip, respectively

Signed-off-by: F.N. Claessen <felix@seita.nl>

* API changelog entry

Signed-off-by: F.N. Claessen <felix@seita.nl>

* Make getService more RESTful

Signed-off-by: F.N. Claessen <felix@seita.nl>

* Add warning to API developer docs

Signed-off-by: F.N. Claessen <felix@seita.nl>

* More robust against spaces

Signed-off-by: F.N. Claessen <felix@seita.nl>

* Update main changelog entry

Signed-off-by: F.N. Claessen <felix@seita.nl>

* Support blackout tests

Signed-off-by: F.N. Claessen <felix@seita.nl>

* black

Signed-off-by: F.N. Claessen <felix@seita.nl>

* Fix test

Signed-off-by: F.N. Claessen <felix@seita.nl>

* More specific if statement

Signed-off-by: F.N. Claessen <felix@seita.nl>

* change default to activating the sunset

Signed-off-by: F.N. Claessen <felix@seita.nl>

* Add sunset documentation for FlexMeasures hosts and make the config settings reusable for future sunsets

Signed-off-by: F.N. Claessen <felix@seita.nl>

* shorten comment

Signed-off-by: F.N. Claessen <felix@seita.nl>

* fix override from config setting

Signed-off-by: F.N. Claessen <felix@seita.nl>

* refactor

Signed-off-by: F.N. Claessen <felix@seita.nl>

* Cross reference to snapshot version of API documentation

Signed-off-by: F.N. Claessen <felix@seita.nl>

* We want to support blackout tests already from the version that announces the deprecation and sunset

Signed-off-by: F.N. Claessen <felix@seita.nl>

* black

Signed-off-by: F.N. Claessen <felix@seita.nl>

* Add cross-reference and explanation, and add clarity

Signed-off-by: F.N. Claessen <felix@seita.nl>

* Customize admonition

Signed-off-by: F.N. Claessen <felix@seita.nl>

* Justify section contents

Signed-off-by: F.N. Claessen <felix@seita.nl>

---------

Signed-off-by: F.N. Claessen <felix@seita.nl>
Co-authored-by: Nicolas Höning <nicolas@seita.nl>
  • Loading branch information
Flix6x and nhoening committed May 1, 2023
1 parent 595e1c3 commit d536cfd
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 1 deletion.
4 changes: 4 additions & 0 deletions documentation/_static/css/custom.css
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
div section {
text-align: justify;
}

div .toctree-wrapper > ul {
column-count: 2;
margin: 0;
Expand Down
2 changes: 1 addition & 1 deletion documentation/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -116,6 +116,7 @@
# relative to this directory. They are copied after the builtin _static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ["_static"]
html_css_files = ["css/custom.css"]

# Custom sidebar templates, must be a dictionary that maps document names
# to template names.
Expand Down Expand Up @@ -223,4 +224,3 @@ def setup(sphinx_app):
"live",
"env", # hard-coded, documentation is not server-specific for the time being
)
sphinx_app.add_css_file("css/custom.css")

0 comments on commit d536cfd

Please sign in to comment.