Comments (7)
Yeah, this would be great.
And we need to add the link to documentations in the README
from clarity.
from clarity.
Cool, I'll look at getting that done early next week. I've done it once and am going through the process of documenting it so I've a reference to work against and will test it out, correcting anything I've gotten wrong (as I'm doing the documentation retrospectively rather than when I was working things out).
from clarity.
And we need to add the link to documentations in the README
I've just added a link to the right-hand sidebar on the repos front page but will check and ensure its present in the README.md
too.
from clarity.
Tasks to complete....
- Add package dependencies to
pyproject.toml
- Include
autoapi.extension
andsphinx_multiversion
packages in theextensions
section ofdocs/conf.py
. - Configure
sphinx-apiauto
indocs/conf.py
. - Configure
sphinx-multiversion
indocs/conf.py
, includinghtml_sidebars = {"**": [ "versioning.html"],}
- Add
_template/versioning.html
for version sidebar. - Update
.github/workflows/sphinx_docs_to_gh_pages.yaml
to work with multiversion ofns-rse/action-sphinx-docs-to-gh-pages@main
.
from clarity.
Currently half-way through this.
Some of the documentation versions build but for some tags there are errors thrown by sphinx-multiversion
...
❱ sphinx-multiversion docs/ docs/_build/html --dump-metadata
Failed load config for refs/tags/v0.1.0 from /tmp/tmpdi_151jw/d5fe105bfa303c0fda54ce3890930459e4a1546b/docs
Failed load config for refs/tags/v0.1.1 from /tmp/tmpdi_151jw/5a25d417b251989725b7f1645744b133f607887c/docs
Failed load config for refs/tags/v0.2.0 from /tmp/tmpdi_151jw/948f32eeb80cef4014107fad8cb3608da305ad67/docs
Failed load config for refs/tags/v0.2.1 from /tmp/tmpdi_151jw/9bddec01884f4ac8a74f12a3d45c45c12ef526fc/docs
{
"main": {
"name": "main",
"version": null,
"release": "",
"is_released": false,
"source": "heads",
"creatordate": "2023-04-19 12:37:03 +0000",
"basedir": "/tmp/tmpdi_151jw/c1147ce61f8f06561611241d6181f4d1824bfb31",
"sourcedir": "/tmp/tmpdi_151jw/c1147ce61f8f06561611241d6181f4d1824bfb31/docs",
"outputdir": "/home/neil/work/projects/claritychallenge/clarity/docs/_build/html/main",
"confdir": "/tmp/tmpdi_151jw/c1147ce61f8f06561611241d6181f4d1824bfb31/docs",
"docnames": [
"CODE_OF_CONDUCT",
"CONTRIBUTING",
"recipe_rsync_exclude",
"usage",
"installation",
"introduction",
"recipes_doc",
"index"
]
},
"v0.3.0": {
"name": "v0.3.0",
"version": null,
"release": "",
"is_released": false,
"source": "tags",
"creatordate": "2023-03-31 16:39:47 +0100",
"basedir": "/tmp/tmpdi_151jw/61ba51371499148ad3d13ea9df7d8ef56a0c441a",
"sourcedir": "/tmp/tmpdi_151jw/61ba51371499148ad3d13ea9df7d8ef56a0c441a/docs",
"outputdir": "/home/neil/work/projects/claritychallenge/clarity/docs/_build/html/v0.3.0",
"confdir": "/tmp/tmpdi_151jw/61ba51371499148ad3d13ea9df7d8ef56a0c441a/docs",
"docnames": [
"CODE_OF_CONDUCT",
"CONTRIBUTING",
"recipe_rsync_exclude",
"usage",
"installation",
"introduction",
"recipes_doc",
"index"
]
},
"v0.3.1": {
"name": "v0.3.1",
"version": null,
"release": "",
"is_released": false,
"source": "tags",
"creatordate": "2023-04-21 10:10:33 +0100",
"basedir": "/tmp/tmpdi_151jw/f6d0f660516a4baf62ebfc18e0cc747aaf681686",
"sourcedir": "/tmp/tmpdi_151jw/f6d0f660516a4baf62ebfc18e0cc747aaf681686/docs",
"outputdir": "/home/neil/work/projects/claritychallenge/clarity/docs/_build/html/v0.3.1",
"confdir": "/tmp/tmpdi_151jw/f6d0f660516a4baf62ebfc18e0cc747aaf681686/docs",
"docnames": [
"CODE_OF_CONDUCT",
"CONTRIBUTING",
"recipe_rsync_exclude",
"usage",
"installation",
"introduction",
"recipes_doc",
"index"
]
}
}
Digging down it appears such errors have cropped up before (e.g. this and this and have been addressed).
I think its because for some reason the docs/conf.py
in the branch/tag can not be found, but adding some debugging to sphinx_multiversion.main.load_sphinx_config_worker()
which makes the call sphinx.config.Config.read()
the file does exist under all branches/tags for which attempts are made to build the documentation...
❱ sphinx-multiversion docs/ docs/_build/html --dump-metadata
/home/neil/work/projects/claritychallenge/clarity/docs/conf.py
os.path.isfile(confpath/conf.py) ???? : True
/tmp/tmp5sfm9wid/c1147ce61f8f06561611241d6181f4d1824bfb31/docs/conf.py
os.path.isfile(confpath/conf.py) ???? : True
/tmp/tmp5sfm9wid/d5fe105bfa303c0fda54ce3890930459e4a1546b/docs/conf.py
os.path.isfile(confpath/conf.py) ???? : True
Failed load config for refs/tags/v0.1.0 from /tmp/tmp5sfm9wid/d5fe105bfa303c0fda54ce3890930459e4a1546b/docs
/tmp/tmp5sfm9wid/5a25d417b251989725b7f1645744b133f607887c/docs/conf.py
os.path.isfile(confpath/conf.py) ???? : True
Failed load config for refs/tags/v0.1.1 from /tmp/tmp5sfm9wid/5a25d417b251989725b7f1645744b133f607887c/docs
/tmp/tmp5sfm9wid/948f32eeb80cef4014107fad8cb3608da305ad67/docs/conf.py
os.path.isfile(confpath/conf.py) ???? : True
Failed load config for refs/tags/v0.2.0 from /tmp/tmp5sfm9wid/948f32eeb80cef4014107fad8cb3608da305ad67/docs
/tmp/tmp5sfm9wid/9bddec01884f4ac8a74f12a3d45c45c12ef526fc/docs/conf.py
os.path.isfile(confpath/conf.py) ???? : True
Failed load config for refs/tags/v0.2.1 from /tmp/tmp5sfm9wid/9bddec01884f4ac8a74f12a3d45c45c12ef526fc/docs
/tmp/tmp5sfm9wid/61ba51371499148ad3d13ea9df7d8ef56a0c441a/docs/conf.py
os.path.isfile(confpath/conf.py) ???? : True
/tmp/tmp5sfm9wid/f6d0f660516a4baf62ebfc18e0cc747aaf681686/docs/conf.py
os.path.isfile(confpath/conf.py) ???? : True
I'll continue to try and get this working though.
from clarity.
Not the only the underlying cause of these failures.
Older releases do not have the version specified in the docs/conf.py
, instead its empty with version = ""
. Didn't start automatic versioning until v0.3.0
.
I've queried if this may be the root cause and hope to receive some advice on resolving it.
from clarity.
Related Issues (20)
- Release to ORDA HOT 4
- Working on Evaluation code CAD1-CPC2
- ICASSP 2024 Cadenza Baseline
- [BUG] smearer tests are failing when using numpy 1.25 or later
- [BUG] ICASSP 2024 is not generating all the data
- Close
- Tutorial notebooks not working with latest version [BUG]
- Forthcoming NumPy2.0 release
- Cleaning MSBG code
- Add precomputations to HAAQI HOT 4
- From HAAQI - HASPI - HASQI
- Preparartion for Cadenza 2 Challenge
- Separation model for replication CAD2 - Task1
- Task 1 - Lyrics Intelligibility
- Multiband Dynamic Range Compressor
- Cadenza 2
- Baseline CAD2 - Task 1
- Precommit is reporting errors
- Unnecessary log HOT 1
- Baseline CAD2 Task 2
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from clarity.