-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
7 changed files
with
1,297 additions
and
81 deletions.
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,35 @@ | ||
| # Read the Docs configuration file for Sphinx projects | ||
| # See https://docs.readthedocs.io/en/stable/config-file/v2.html for details | ||
|
|
||
| # Required | ||
| version: 2 | ||
|
|
||
| # Set the OS, Python version and other tools you might need | ||
| build: | ||
| os: ubuntu-22.04 | ||
| tools: | ||
| python: "3.11" | ||
| # You can also specify other tool versions: | ||
| # nodejs: "20" | ||
| # rust: "1.70" | ||
| # golang: "1.20" | ||
|
|
||
| # Build documentation in the "docs/" directory with Sphinx | ||
| sphinx: | ||
| configuration: docs/source/conf.py | ||
| # You can configure Sphinx to use a different builder, for instance use the dirhtml builder for simpler URLs | ||
| # builder: "dirhtml" | ||
| # Fail on all warnings to avoid broken references | ||
| # fail_on_warning: true | ||
|
|
||
| # Optionally build your docs in additional formats such as PDF and ePub | ||
| # formats: | ||
| # - epub | ||
|
|
||
| # Optional but recommended, declare the Python requirements required | ||
| # to build your documentation | ||
| # See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html | ||
| python: | ||
| install: | ||
| - requirements: requirements.txt |
This file was deleted.
Oops, something went wrong.
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,54 @@ | ||
| # Configuration file for the Sphinx documentation builder. | ||
| # | ||
| # For the full list of built-in configuration values, see the documentation: | ||
| # https://www.sphinx-doc.org/en/master/usage/configuration.html | ||
|
|
||
| # -- Project information ----------------------------------------------------- | ||
| # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information | ||
|
|
||
| import re | ||
| import time | ||
|
|
||
| project = 'PyMonCtl' | ||
| year = time.strftime("%Y") | ||
| author = 'Kalmat' | ||
| copyright = year + ", " + author | ||
| release = "latest" | ||
| with open("../../src/pymonctl/__init__.py", "r") as fileObj: | ||
| match = re.search( | ||
| r'^__version__\s*=\s*[\'"]([^\'"]*)[\'"]', fileObj.read(), re.MULTILINE | ||
| ) | ||
| if match: | ||
| release = match.group(1) | ||
|
|
||
| # -- General configuration --------------------------------------------------- | ||
| # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration | ||
| extensions = ["myst_parser"] | ||
| myst_enable_extensions = ["colon_fence"] | ||
| source_suffix = { | ||
| '.rst': 'restructuredtext', | ||
| '.txt': 'markdown', | ||
| '.md': 'markdown', | ||
| } | ||
| templates_path = ['_templates'] | ||
| exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] | ||
|
|
||
| # -- Options for HTML output ------------------------------------------------- | ||
| # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output | ||
| # https://www.sphinx-doc.org/en/master/usage/theming.html | ||
| html_theme = 'bizstyle' | ||
| html_static_path = ['_static'] | ||
| myst_heading_anchors = 7 | ||
|
|
||
| # -- Copy the modules documentation ------------------------------------------ | ||
| # https://stackoverflow.com/questions/66495200/is-it-possible-to-include-external-rst-files-in-my-documentation | ||
| from urllib.request import urlretrieve | ||
|
|
||
| # urlretrieve( | ||
| # "https://raw.githubusercontent.com/kalmat/pymonctl/master/README.md", | ||
| # "index.md" | ||
| # ) | ||
| # urlretrieve( | ||
| # "https://raw.githubusercontent.com/kalmat/pymonctl/master/docstrings.md", | ||
| # "docstrings.md" | ||
| # ) |
Oops, something went wrong.