reflectivity / orsopy

http://www.reflectometry.org/orsopy/
MIT License
0 stars 8 forks source link

Docs badge shows failing #121

Open aglavic opened 9 months ago

aglavic commented 9 months ago

There seems to be a problem with biulding the documentation, although the data looks fine to me.

I don't have access to this repository settings, so I can't check the github pages configuration. @arm61 , can you have a look?

bmaranville commented 9 months ago

I suggest we move to a self-build of documentation, rather than using readthedocs. It will ease shared administration and reduce points of failure (one less account to deal with)

arm61 commented 9 months ago

@aglavic is apparently an admin on the readthedocs page. But I agree with @bmaranville that it makes things easier to bring it into GitHub.

For reference, the readthedocs seems to be breaking due to a detached HEAD in the git repo?

Build id: 23540584
Project: orsopy
Version: latest
Commit: None
Date: 2024-02-23T14:31:25.484388Z
State: finished
Success: False

[rtd-command-info] start-time: 2024-02-23T14:31:26.239776Z, end-time: 2024-02-23T14:31:26.689108Z, duration: 0, exit-code: 0
git clone --depth 1 https://github.com/reflectivity/orsopy.git .
Cloning into '.'...

[rtd-command-info] start-time: 2024-02-23T14:31:26.721131Z, end-time: 2024-02-23T14:31:27.523293Z, duration: 0, exit-code: 0
git fetch origin --force --prune --prune-tags --depth 50 refs/heads/main:refs/remotes/origin/main
From https://github.com/reflectivity/orsopy
 * [new tag]         v0.0.2     -> v0.0.2
 * [new tag]         v0.0.3     -> v0.0.3
 * [new tag]         v0.0.4     -> v0.0.4
 * [new tag]         v0.0.5     -> v0.0.5
 * [new tag]         v0.1.0     -> v0.1.0
 * [new tag]         v0.1.1     -> v0.1.1
 * [new tag]         v1.0.0     -> v1.0.0
 * [new tag]         v1.0.1     -> v1.0.1
 * [new tag]         v1.1.0     -> v1.1.0

[rtd-command-info] start-time: 2024-02-23T14:31:27.606551Z, end-time: 2024-02-23T14:31:27.732155Z, duration: 0, exit-code: 0
git checkout --force origin/main
Note: switching to 'origin/main'.

You are in 'detached HEAD' state. You can look around, make experimental
changes and commit them, and you can discard any commits you make in this
state without impacting any branches by switching back to a branch.

If you want to create a new branch to retain commits you create, you may
do so (now or later) by using -c with the switch command. Example:

  git switch -c <new-branch-name>

Or undo this operation with:

  git switch -

Turn off this advice by setting config variable advice.detachedHead to false

HEAD is now at 63d7930 Merge pull request #111 for release v1.2.0

[rtd-command-info] start-time: 2024-02-23T14:31:27.756482Z, end-time: 2024-02-23T14:31:27.817131Z, duration: 0, exit-code: 0
git clean -d -f -f
aglavic commented 9 months ago

Ah, I wasn't aware the readthedocs thing was a separate service. I never even logged in to that website before.

I'll look into the build and see if I can fix it. For future I agree to have it all here on GitHub. (Would appreciate a pull-request from someone who knows how to do that.)

bmaranville commented 9 months ago

see #122