Add readthedocs #188
Open
Add readthedocs #188
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Sophie Frasnedo <[email protected]>
Signed-off-by: Sophie Frasnedo <[email protected]>
|
Comment on lines
+42
to
+62
| # We have a single source of truth for our version number: the project's pom.xml file. | ||
| # This next bit of code reads from it. | ||
| file_with_version = os.path.join(source_path, "pom.xml") | ||
| with open(file_with_version) as f: | ||
| next_line_contains_version = False | ||
| for line in f: | ||
| if next_line_contains_version == False: | ||
| m = re.match(r'^ {4}\<artifactId\>' + module_name + r'\<\/artifactId\>', line) | ||
| if m: | ||
| next_line_contains_version = True | ||
| else: | ||
| m = re.match(r'^ {4}\<version\>(.*)\<\/version\>', line) | ||
| if m: | ||
| __version__ = m.group(1) | ||
| # The short X.Y version. | ||
| version = ".".join(__version__.split(".")[:2]) | ||
| # The full version, including alpha/beta/rc tags. | ||
| release = __version__ | ||
| break | ||
| else: # AKA no-break | ||
| version = release = "dev" |
There was a problem hiding this comment.
We don't have a pom.xml but a package.json in Node project.
Comment on lines
+162
to
+176
| # Replace the default version in the URL with the version from the pom.xml | ||
| def replace_versions(intersphinx_mapping, file): | ||
| with open(file) as f: | ||
| for line in f: | ||
| m = re.match(r'^ {8}\<(.*)\.version\>(.*)\<\/(.*)\.version\>', line) | ||
| if m and m.group(1) == m.group(3): | ||
| dependency = m.group(1) | ||
| version = m.group(2) | ||
| if "SNAPSHOT" not in version and dependency in intersphinx_mapping: | ||
| url_start = extract_base_url(intersphinx_mapping[dependency][0]) | ||
| if url_start: | ||
| intersphinx_mapping[dependency] = (url_start + version + "/", None) | ||
| if "</properties>" in line: | ||
| break | ||
| return intersphinx_mapping |
Comment on lines
+4
to
+6
| os: ubuntu-20.04 | ||
| tools: | ||
| python: "3.9" |
There was a problem hiding this comment.
From the example
Suggested change
| os: ubuntu-20.04 | |
| tools: | |
| python: "3.9" | |
| os: ubuntu-22.04 | |
| tools: | |
| python: "3.10" |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Please check if the PR fulfills these requirements
What kind of change does this PR introduce?
Add readthedocs configuration files
Does this PR introduce a breaking change or deprecate an API?