Dashboard-Tactics (Dash T)

[rgleason]

Users, we have a problem, the ReadtheDocs documentation for Dashboard_tactics is missing. The documentation was excellent, as Petri spent considerable time testing and refining the plugin with good documentation. My email for Petri now bounces and ReadtheDocs does not have access to the deleted project.

If anyone has downloaded or made epub copies of that documentation, we would very much appreciate your contacting us via this thread so that we can have more complete documentation of this plugin.


Note that Dashboard_tactics is based on Thomas Rauch's Tactics plugin, so I would suggest using that documentation if we cannot find a copy of Petri's.

Sorry, but perhaps this is an example for why we should try to have all the documentation in one secure place.

[nohal]

I don't know what there was on readthedocs, but it looks like the source for for it might be in https://github.com/rgleason/dashboar...ee/master/docs

[rgleason]

Thanks, Pavel. Looking at it more carefully, I think you might be right. Petri must have included his documentation in his github repository as well as having it in readthedocs. This is a great find. Thank you.



Now the question is how to either get it back up on readthedocs or how to convert it to be compatible with asciidoc/antora on our manual repository for plugins?


I suppose this will take some digging.

Originally Posted by nohal

I don't know what there was on readthedocs, but it looks like the source for for it might be in https://github.com/rgleason/dashboar...ee/master/docs

[nohal]

Are you sure? I see pages like https://github.com/rgleason/dashboar...acestart.ipynb there. They don't seem brief or summary.

[nohal]

Originally Posted by rgleason

I suppose this will take some digging.

• Go to https://readthedocs.org/
• Register with your Github account
• Import the project
• Done

[rgleason]

Originally Posted by nohal

• Go to https://readthedocs.org/
• Register with your Github account
• Import the project
• Done

Thank you Pavel!

[rgleason]

I've made two commits to fix the required updates to readthedocs.yml including trying to add an os: and it still fails to build. Here is the result https://readthedocs.org/api/v2/build/22965300.txt

Here is what is in readthedocs.yml
https://github.com/rgleason/dashboar...eadthedocs.yml
which references a pre-existing file https://github.com/rgleason/dashboar...quirements.txt for sphinx settings.
ipykernel==5.5.5
nbsphinx==0.8.5
Sphinx==4.0.2
Pygments==2.9.0


I did add the these lines:

# Set the version of Python and other tools you might need
build:
os: ubuntu-22.04
tools:
python: "3.11"

[nohal]

There is no error in the build log you linked so there is no advice I can give you on how to fix it.

[rgleason]

The project Dashboard_Tactics doesn't have a valid webhook set up, commits won't trigger new builds for this project. See the project integrations for more information.

Completed Dec. 28, 2023. 1:58 a.m.
Build took 14 seconds
View raw

Build #22965437
latest
Build failed
Error

Problem in your project's configuration. Invalid configuration option "python.version": Make sure the key name is correct.

git clone --depth 1 https://github.com/rgleason/dashboard_tactics_pi.git .
git fetch origin --force --prune --prune-tags --depth 50 refs/heads/master:refs/remotes/origin/master
git checkout --force origin/master
git clean -d -f -f

[nohal]

Do what it tells you, remove the line "version: 3.11" under "python:"
What are valid configuration options you can read at https://docs.readthedocs.io/en/stabl...g-file/v2.html

[rgleason]

Which one would you suggest removing, there are two?


https://github.com/rgleason/dashboar...eadthedocs.yml


So you want line 21 removed? Yes, I guess that is it. Will try that.

[rgleason]

Some progress. It started building, but there is an error from somewhere. I hope you can read this.

[nohal]

Either use older version of Python (3.9 or older) in https://github.com/rgleason/dashboar...hedocs.yml#L11 or newer version of Sphinx (4.3.0 or newer if I read their changelog correctly) with support for newer python in https://github.com/rgleason/dashboar...rements.txt#L3

I do not know why you decided to upgrade python used from 3.7 to 3.11 in the first place, so I do not know which of the two is appropriate or less problematic.

[rgleason]

I believe the initial error page said python 3.7 was not supported and that they no longer supported ubuntu 18. The reason I put python at 3.11 is because their example page shows that. Also the example page shows use of OS ubuntu 22 Does this help?

Originally Posted by nohal

Either use older version of Python (3.9 or older) in https://github.com/rgleason/dashboar...hedocs.yml#L11 or newer version of Sphinx (4.3.0 or newer if I read their changelog correctly) with support for newer python in https://github.com/rgleason/dashboar...rements.txt#L3

I do not know why you decided to upgrade python used from 3.7 to 3.11 in the first place, so I do not know which of the two is appropriate or less problematic.

[nohal]

Simply do one of the two things and see what happens.