Upgrade Documentation (use Conda env. file, use Markdown instead of reStructuredText) #64
Conversation
| # sphinx | ||
| - sphinx=7.3.7 # core builder # https://anaconda.org/conda-forge/sphinx/files | ||
| # theme and extensions | ||
| - pydata-sphinx-theme=0.15.3 # website theme # https://anaconda.org/conda-forge/pydata-sphinx-theme/files |
There was a problem hiding this comment.
@jakobsarthur, these are the pinned versions I was referring to. You can always bump the package versions when either:
- You have tested the build with the new versions locally
- the docs.brightway.dev repo has bumped them
| @@ -0,0 +1,189 @@ | |||
| # Theory | |||
There was a problem hiding this comment.
Markdown is highly preferred! Otherwise, you won't be able to take advantage of all the MyST parser functionality.
| @@ -1,12 +1,7 @@ | |||
| ### path setup #################################################################################### | |||
|
|
|||
| from glob import glob | |||
There was a problem hiding this comment.
I found that my local build works fine without these below definitions. Please let me know if this broke some other part of the documentation I am unaware of.
| include: all | ||
|
|
||
| build: | ||
| os: "ubuntu-lts-latest" # https://docs.readthedocs.io/en/stable/config-file/v2.html#build-os |
There was a problem hiding this comment.
This is a new feature, but will ensure that the build always uses the most up-to-date platforms provided by RTD.
| - sphinx-favicon=1.0.1 # for custom favicons # https://anaconda.org/conda-forge/sphinx-favicon/files | ||
| - sphinx-copybutton=0.5.2 # for copy button in code blocks # https://anaconda.org/conda-forge/sphinx-copybutton/files | ||
| # build process | ||
| - sphinx-autobuild=2024.4.16 # live-html support # https://anaconda.org/conda-forge/sphinx-autobuild/files |
There was a problem hiding this comment.
...please check if you need any other packages.
jakobsarthur
requested review from
TimoDiepers
and removed request for
TimoDiepers
|
I built it locally and it seems to all be working! will goahead and merge |
No description provided.