Skip to content

Commit

Permalink
🧪 Remove plantuml config from test builds conf.py (#1059)
Browse files Browse the repository at this point in the history
In #1051 setting of the `plantuml` config option was moved centrally into `test_app`.
This commit removes the config from individual `conf.py`
  • Loading branch information
chrisjsewell authored Nov 3, 2023
1 parent 6391935 commit 2a97e95
Show file tree
Hide file tree
Showing 99 changed files with 89 additions and 652 deletions.
7 changes: 0 additions & 7 deletions tests/doc_test/add_sections/conf.py
Original file line number Diff line number Diff line change
@@ -1,14 +1,7 @@
import os

from docutils.parsers.rst import directives

extensions = ["sphinx_needs"]

plantuml = "java -Djava.awt.headless=true -jar %s" % os.path.join(
os.path.dirname(__file__), "..", "utils", "plantuml.jar"
)
plantuml_output_format = "svg"

needs_extra_options = {
"introduced": directives.unchanged,
"updated": directives.unchanged,
Expand Down
7 changes: 0 additions & 7 deletions tests/doc_test/api_doc/conf.py
Original file line number Diff line number Diff line change
@@ -1,12 +1,5 @@
import os

extensions = ["sphinx_needs", "dummy_extension.dummy"]

plantuml = "java -Djava.awt.headless=true -jar %s" % os.path.join(
os.path.dirname(__file__), "..", "utils", "plantuml.jar"
)
plantuml_output_format = "svg"

needs_types = [
{"directive": "story", "title": "User Story", "prefix": "US_", "color": "#BFD8D2", "style": "node"},
{"directive": "spec", "title": "Specification", "prefix": "SP_", "color": "#FEDCD2", "style": "node"},
Expand Down
7 changes: 0 additions & 7 deletions tests/doc_test/api_doc_awesome/conf.py
Original file line number Diff line number Diff line change
@@ -1,12 +1,5 @@
import os

extensions = ["sphinx_needs", "dummy_extension.dummy"]

plantuml = "java -Djava.awt.headless=true -jar %s" % os.path.join(
os.path.dirname(__file__), "..", "utils", "plantuml.jar"
)
plantuml_output_format = "svg"

needs_types = [
{"directive": "story", "title": "User Story", "prefix": "US_", "color": "#BFD8D2", "style": "node"},
{"directive": "spec", "title": "Specification", "prefix": "SP_", "color": "#FEDCD2", "style": "node"},
Expand Down
7 changes: 1 addition & 6 deletions tests/doc_test/arch_doc/conf.py
Original file line number Diff line number Diff line change
@@ -1,10 +1,5 @@
import os

extensions = ["sphinx_needs", "sphinxcontrib.plantuml"]

plantuml = "java -Djava.awt.headless=true -jar %s" % os.path.join(
os.path.dirname(__file__), "..", "utils", "plantuml.jar"
)
# note, the plantuml executable command is set globally in the test suite
plantuml_output_format = "svg"

needs_types = [
Expand Down
7 changes: 0 additions & 7 deletions tests/doc_test/broken_doc/conf.py
Original file line number Diff line number Diff line change
@@ -1,12 +1,5 @@
import os

extensions = ["sphinx_needs"]

plantuml = "java -Djava.awt.headless=true -jar %s" % os.path.join(
os.path.dirname(__file__), "..", "utils", "plantuml.jar"
)
plantuml_output_format = "svg"

needs_types = [
{"directive": "story", "title": "User Story", "prefix": "US_", "color": "#BFD8D2", "style": "node"},
{"directive": "spec", "title": "Specification", "prefix": "SP_", "color": "#FEDCD2", "style": "node"},
Expand Down
7 changes: 0 additions & 7 deletions tests/doc_test/broken_links/conf.py
Original file line number Diff line number Diff line change
@@ -1,12 +1,5 @@
import os

extensions = ["sphinx_needs"]

plantuml = "java -Djava.awt.headless=true -jar %s" % os.path.join(
os.path.dirname(__file__), "..", "utils", "plantuml.jar"
)
plantuml_output_format = "svg"

needs_types = [
{"directive": "story", "title": "User Story", "prefix": "US_", "color": "#BFD8D2", "style": "node"},
{"directive": "spec", "title": "Specification", "prefix": "SP_", "color": "#FEDCD2", "style": "node"},
Expand Down
7 changes: 0 additions & 7 deletions tests/doc_test/broken_statuses/conf.py
Original file line number Diff line number Diff line change
@@ -1,12 +1,5 @@
import os

extensions = ["sphinx_needs"]

plantuml = "java -Djava.awt.headless=true -jar %s" % os.path.join(
os.path.dirname(__file__), "..", "utils", "plantuml.jar"
)
plantuml_output_format = "svg"

needs_types = [
{"directive": "story", "title": "User Story", "prefix": "US_", "color": "#BFD8D2", "style": "node"},
{"directive": "spec", "title": "Specification", "prefix": "SP_", "color": "#FEDCD2", "style": "node"},
Expand Down
7 changes: 0 additions & 7 deletions tests/doc_test/broken_syntax_doc/conf.py
Original file line number Diff line number Diff line change
@@ -1,12 +1,5 @@
import os

extensions = ["sphinx_needs"]

plantuml = "java -Djava.awt.headless=true -jar %s" % os.path.join(
os.path.dirname(__file__), "..", "utils", "plantuml.jar"
)
plantuml_output_format = "svg"

needs_types = [
{"directive": "story", "title": "User Story", "prefix": "US_", "color": "#BFD8D2", "style": "node"},
{"directive": "spec", "title": "Specification", "prefix": "SP_", "color": "#FEDCD2", "style": "node"},
Expand Down
7 changes: 0 additions & 7 deletions tests/doc_test/broken_tags/conf.py
Original file line number Diff line number Diff line change
@@ -1,12 +1,5 @@
import os

extensions = ["sphinx_needs"]

plantuml = "java -Djava.awt.headless=true -jar %s" % os.path.join(
os.path.dirname(__file__), "..", "utils", "plantuml.jar"
)
plantuml_output_format = "svg"

needs_types = [
{"directive": "story", "title": "User Story", "prefix": "US_", "color": "#BFD8D2", "style": "node"},
{"directive": "spec", "title": "Specification", "prefix": "SP_", "color": "#FEDCD2", "style": "node"},
Expand Down
7 changes: 0 additions & 7 deletions tests/doc_test/broken_tags_2/conf.py
Original file line number Diff line number Diff line change
@@ -1,12 +1,5 @@
import os

extensions = ["sphinx_needs"]

plantuml = "java -Djava.awt.headless=true -jar %s" % os.path.join(
os.path.dirname(__file__), "..", "utils", "plantuml.jar"
)
plantuml_output_format = "svg"

needs_types = [
{"directive": "story", "title": "User Story", "prefix": "US_", "color": "#BFD8D2", "style": "node"},
{"directive": "spec", "title": "Specification", "prefix": "SP_", "color": "#FEDCD2", "style": "node"},
Expand Down
6 changes: 1 addition & 5 deletions tests/doc_test/doc_basic/conf.py
Original file line number Diff line number Diff line change
@@ -1,10 +1,6 @@
import os

extensions = ["sphinx_needs", "sphinxcontrib.plantuml"]

plantuml = "java -Djava.awt.headless=true -jar %s" % os.path.join(
os.path.dirname(__file__), "..", "utils", "plantuml.jar"
)
# note, the plantuml executable command is set globally in the test suite
plantuml_output_format = "svg"

needs_id_regex = "^[A-Za-z0-9_]"
Expand Down
6 changes: 1 addition & 5 deletions tests/doc_test/doc_basic_latex/conf.py
Original file line number Diff line number Diff line change
@@ -1,12 +1,8 @@
import os

project = "basic test"

extensions = ["sphinx_needs", "sphinxcontrib.plantuml"]

plantuml = "java -Djava.awt.headless=true -jar %s" % os.path.join(
os.path.dirname(__file__), "..", "utils", "plantuml.jar"
)
# note, the plantuml executable command is set globally in the test suite
plantuml_output_format = "svg"

needs_id_regex = "^[A-Za-z0-9_]"
Expand Down
6 changes: 1 addition & 5 deletions tests/doc_test/doc_build_latex/conf.py
Original file line number Diff line number Diff line change
@@ -1,12 +1,8 @@
import os

project = "needs test docs"

extensions = ["sphinx_needs", "sphinxcontrib.plantuml"]

plantuml = "java -Djava.awt.headless=true -jar %s" % os.path.join(
os.path.dirname(__file__), "..", "utils", "plantuml.jar"
)
# note, the plantuml executable command is set globally in the test suite
plantuml_output_format = "svg"

# figures, tables and code-blocks are automatically numbered if they have a caption
Expand Down
7 changes: 0 additions & 7 deletions tests/doc_test/doc_df_calc_sum/conf.py
Original file line number Diff line number Diff line change
@@ -1,14 +1,7 @@
import os

from docutils.parsers.rst import directives

extensions = ["sphinx_needs"]

plantuml = "java -Djava.awt.headless=true -jar %s" % os.path.join(
os.path.dirname(__file__), "..", "utils", "plantuml.jar"
)
plantuml_output_format = "svg"

needs_types = [
{"directive": "story", "title": "User Story", "prefix": "US_", "color": "#BFD8D2", "style": "node"},
{"directive": "spec", "title": "Specification", "prefix": "SP_", "color": "#FEDCD2", "style": "node"},
Expand Down
7 changes: 0 additions & 7 deletions tests/doc_test/doc_df_check_linked_values/conf.py
Original file line number Diff line number Diff line change
@@ -1,14 +1,7 @@
import os

from docutils.parsers.rst import directives

extensions = ["sphinx_needs"]

plantuml = "java -Djava.awt.headless=true -jar %s" % os.path.join(
os.path.dirname(__file__), "..", "utils", "plantuml.jar"
)
plantuml_output_format = "svg"

needs_types = [
{"directive": "story", "title": "User Story", "prefix": "US_", "color": "#BFD8D2", "style": "node"},
{"directive": "spec", "title": "Specification", "prefix": "SP_", "color": "#FEDCD2", "style": "node"},
Expand Down
7 changes: 0 additions & 7 deletions tests/doc_test/doc_df_user_functions/conf.py
Original file line number Diff line number Diff line change
@@ -1,14 +1,7 @@
import os

from docutils.parsers.rst import directives

extensions = ["sphinx_needs"]

plantuml = "java -Djava.awt.headless=true -jar %s" % os.path.join(
os.path.dirname(__file__), "..", "utils", "plantuml.jar"
)
plantuml_output_format = "svg"

needs_types = [
{"directive": "story", "title": "User Story", "prefix": "US_", "color": "#BFD8D2", "style": "node"},
{"directive": "spec", "title": "Specification", "prefix": "SP_", "color": "#FEDCD2", "style": "node"},
Expand Down
7 changes: 0 additions & 7 deletions tests/doc_test/doc_dynamic_functions/conf.py
Original file line number Diff line number Diff line change
@@ -1,14 +1,7 @@
import os

from docutils.parsers.rst import directives

extensions = ["sphinx_needs"]

plantuml = "java -Djava.awt.headless=true -jar %s" % os.path.join(
os.path.dirname(__file__), "..", "utils", "plantuml.jar"
)
plantuml_output_format = "svg"

needs_types = [
{"directive": "story", "title": "User Story", "prefix": "US_", "color": "#BFD8D2", "style": "node"},
{"directive": "spec", "title": "Specification", "prefix": "SP_", "color": "#FEDCD2", "style": "node"},
Expand Down
6 changes: 1 addition & 5 deletions tests/doc_test/doc_export_id/conf.py
Original file line number Diff line number Diff line change
@@ -1,12 +1,8 @@
import os

version = "1.0"

extensions = ["sphinx_needs", "sphinxcontrib.plantuml"]

plantuml = "java -Djava.awt.headless=true -jar %s" % os.path.join(
os.path.dirname(__file__), "..", "utils", "plantuml.jar"
)
# note, the plantuml executable command is set globally in the test suite
plantuml_output_format = "svg"

needs_types = [
Expand Down
6 changes: 1 addition & 5 deletions tests/doc_test/doc_extra_links/conf.py
Original file line number Diff line number Diff line change
@@ -1,12 +1,8 @@
import os

project = "needs test docs"

extensions = ["sphinx_needs", "sphinxcontrib.plantuml"]

plantuml = "java -Djava.awt.headless=true -jar %s" % os.path.join(
os.path.dirname(__file__), "..", "utils", "plantuml.jar"
)
# note, the plantuml executable command is set globally in the test suite
plantuml_output_format = "svg"

needs_types = [
Expand Down
6 changes: 1 addition & 5 deletions tests/doc_test/doc_github_issue_160/conf.py
Original file line number Diff line number Diff line change
@@ -1,10 +1,6 @@
import os

extensions = ["sphinx_needs", "sphinxcontrib.plantuml"]

plantuml = "java -Djava.awt.headless=true -jar %s" % os.path.join(
os.path.dirname(__file__), "..", "utils", "plantuml.jar"
)
# note, the plantuml executable command is set globally in the test suite
plantuml_output_format = "svg"

needs_id_regex = "^[A-Z0-9]-[A-Z0-9]+"
7 changes: 0 additions & 7 deletions tests/doc_test/doc_github_issue_21/conf.py
Original file line number Diff line number Diff line change
@@ -1,12 +1,5 @@
import os

extensions = ["sphinx_needs"]

plantuml = "java -Djava.awt.headless=true -jar %s" % os.path.join(
os.path.dirname(__file__), "..", "utils", "plantuml.jar"
)
plantuml_output_format = "svg"

needs_types = [
{"directive": "story", "title": "User Story", "prefix": "US_", "color": "#BFD8D2", "style": "node"},
{"directive": "spec", "title": "Specification", "prefix": "SP_", "color": "#FEDCD2", "style": "node"},
Expand Down
7 changes: 0 additions & 7 deletions tests/doc_test/doc_github_issue_44/conf.py
Original file line number Diff line number Diff line change
@@ -1,12 +1,5 @@
import os

extensions = ["sphinx_needs"]

plantuml = "java -Djava.awt.headless=true -jar %s" % os.path.join(
os.path.dirname(__file__), "..", "utils", "plantuml.jar"
)
plantuml_output_format = "svg"

needs_id_regex = "^[A-Za-z0-9_]"

needs_types = [
Expand Down
6 changes: 1 addition & 5 deletions tests/doc_test/doc_github_issue_61/conf.py
Original file line number Diff line number Diff line change
@@ -1,10 +1,6 @@
import os

extensions = ["sphinx_needs", "sphinxcontrib.plantuml"]

plantuml = "java -Djava.awt.headless=true -jar %s" % os.path.join(
os.path.dirname(__file__), "..", "utils", "plantuml.jar"
)
# note, the plantuml executable command is set globally in the test suite
plantuml_output_format = "svg"

needs_id_regex = "^[A-Z0-9]-[A-Z0-9]+"
7 changes: 0 additions & 7 deletions tests/doc_test/doc_global_options/conf.py
Original file line number Diff line number Diff line change
@@ -1,12 +1,5 @@
import os

extensions = ["sphinx_needs"]

plantuml = "java -Djava.awt.headless=true -jar %s" % os.path.join(
os.path.dirname(__file__), "..", "utils", "plantuml.jar"
)
plantuml_output_format = "svg"

needs_types = [
{"directive": "story", "title": "User Story", "prefix": "US_", "color": "#BFD8D2", "style": "node"},
{"directive": "spec", "title": "Specification", "prefix": "SP_", "color": "#FEDCD2", "style": "node"},
Expand Down
7 changes: 0 additions & 7 deletions tests/doc_test/doc_layout/conf.py
Original file line number Diff line number Diff line change
@@ -1,14 +1,7 @@
import os

from docutils.parsers.rst import directives

extensions = ["sphinx_needs"]

plantuml = "java -Djava.awt.headless=true -jar %s" % os.path.join(
os.path.dirname(__file__), "..", "utils", "plantuml.jar"
)
plantuml_output_format = "svg"

needs_types = [
{"directive": "story", "title": "User Story", "prefix": "US_", "color": "#BFD8D2", "style": "node"},
{"directive": "spec", "title": "Specification", "prefix": "SP_", "color": "#FEDCD2", "style": "node"},
Expand Down
6 changes: 1 addition & 5 deletions tests/doc_test/doc_list2need/conf.py
Original file line number Diff line number Diff line change
@@ -1,10 +1,6 @@
import os

extensions = ["sphinx_needs", "sphinxcontrib.plantuml"]

plantuml = "java -Djava.awt.headless=true -jar %s" % os.path.join(
os.path.dirname(__file__), "..", "utils", "plantuml.jar"
)
# note, the plantuml executable command is set globally in the test suite
plantuml_output_format = "svg"

needs_table_style = "TABLE"
Expand Down
4 changes: 1 addition & 3 deletions tests/doc_test/doc_measure_time/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,7 @@

extensions = ["sphinx_needs", "sphinxcontrib.plantuml"]

plantuml = "java -Djava.awt.headless=true -jar %s" % os.path.join(
os.path.dirname(__file__), "..", "utils", "plantuml.jar"
)
# note, the plantuml executable command is set globally in the test suite
plantuml_output_format = "svg"

needs_debug_measurement = True
Expand Down
7 changes: 0 additions & 7 deletions tests/doc_test/doc_need_count/conf.py
Original file line number Diff line number Diff line change
@@ -1,12 +1,5 @@
import os

extensions = ["sphinx_needs"]

plantuml = "java -Djava.awt.headless=true -jar %s" % os.path.join(
os.path.dirname(__file__), "..", "utils", "plantuml.jar"
)
plantuml_output_format = "svg"

needs_types = [
{"directive": "story", "title": "User Story", "prefix": "US_", "color": "#BFD8D2", "style": "node"},
{"directive": "spec", "title": "Specification", "prefix": "SP_", "color": "#FEDCD2", "style": "node"},
Expand Down
6 changes: 1 addition & 5 deletions tests/doc_test/doc_need_delete/conf.py
Original file line number Diff line number Diff line change
@@ -1,10 +1,6 @@
import os

extensions = ["sphinx_needs", "sphinxcontrib.plantuml"]

plantuml = "java -Djava.awt.headless=true -jar %s" % os.path.join(
os.path.dirname(__file__), "..", "utils", "plantuml.jar"
)
# note, the plantuml executable command is set globally in the test suite
plantuml_output_format = "svg"

needs_id_regex = "^[A-Za-z0-9_]"
Expand Down
7 changes: 0 additions & 7 deletions tests/doc_test/doc_need_id_from_title/conf.py
Original file line number Diff line number Diff line change
@@ -1,12 +1,5 @@
import os

extensions = ["sphinx_needs"]

plantuml = "java -Djava.awt.headless=true -jar %s" % os.path.join(
os.path.dirname(__file__), "..", "utils", "plantuml.jar"
)
plantuml_output_format = "svg"

needs_types = [
{"directive": "story", "title": "User Story", "prefix": "US_", "color": "#BFD8D2", "style": "node"},
{"directive": "spec", "title": "Specification", "prefix": "SP_", "color": "#FEDCD2", "style": "node"},
Expand Down
Loading

0 comments on commit 2a97e95

Please sign in to comment.