DO NOT MERGE--test of docs preview

[bertiewooster]

Reference Issue

Testing docs build preview following PR #7217, based on issue #6849

What does this implement/fix? Explain your changes.

This PR is just to trigger a CI run to build docs preview

Any other comments?

---

📚 Documentation preview 📚: https://rdkit--7219.org.readthedocs.build/en/7219/

[bertiewooster]

Good news: The Documentation preview link appeared under the PR description. Bad news: It gives a 404 error

📚 Documentation preview 📚: https://rdkit--7219.org.readthedocs.build/en/7219/

The GitHub Action completed successfully:

readthedocs/actions / documentation-links (pull_request_target) Successful in 7s
Details

There were no obvious problems in that log; the only thing that struck me as a potential issue is:

Checking out the ref
/usr/bin/git checkout --progress --force refs/tags/v1
Note: switching to 'refs/tags/v1'.

You are in 'detached HEAD' state.

though that may be standard for this situation?

[bertiewooster]

@greglandrum Could you check for an error message on the Read the Docs project page or the like?

[greglandrum]

@greglandrum Could you check for an error message on the Read the Docs project page or the like?

@bertiewooster I don't see anything. It also doesn't look like RtD try to do a build based on this:
https://readthedocs.org/projects/rdkit/builds/

[greglandrum]

I think this may be more complicated to make work than what we've done so far since you can't build the RDKit docs without having an actual build of the RDKit available. So I think some connection to RtD needs to be somehow integrated into one of the RDKit CI jobs

[bertiewooster]

It also doesn't look like RtD try to do a build based on this: https://readthedocs.org/projects/rdkit/builds/

The last successful build is Passed version release_2019_03 (html)4 years, 9 months ago, which makes me wonder if this RtD project is the current documentation platform?

[greglandrum]

The last successful build is Passed version release_2019_03 (html)4 years, 9 months ago, which makes me wonder if this RtD project is the current documentation platform?

It's definitely not. I manually build the docs that are hosted on rdkit.org. Those are, to the best of my knowledge, the only online version of the docs that are kept up to date.

[bertiewooster]

I misinterpreted your original comment, about using the RtD GitHub Action, as meaning that the RDKit docs are built using RtD. I believe we would need to get that set up first before we could use that GitHub Action to build the docs from a pull request. As you mentioned, that would presumably require making a build of the RDKit available using CI. It seems a worthy goal to automatically build the docs for each release from CI, to save you from building the docs manually.

If that's not a simple task, to avoid having each new PR post a broken link on the PR's web page, you might want to revert the merge of #7217. Unless you'd prefer that I submit another PR to comment out the contents of .github/workflows/documentation-links.yml so we have that code ready to go when RtD can build the docs from CI.

[greglandrum]

I agree that it would be great to have this work and to both have the docs generated automatically and to be able to check them docs with each PR, but since it's not currently working I am going to revert the PR.

I think a likely solution at the PR level would be to have one of the CI builds generate the docs and then somehow push those to RtD. I assume that this is possible, but haven't managed to make the time to investigate yet.

[bertiewooster]

Similarly, are the RDKit C++ and Python builds for release created by CI? If not, that would also be a worthy goal, and probably a prerequisite for building the docs via CI.

[greglandrum]

Similarly, are the RDKit C++ and Python builds for release created by CI? If not, that would also be a worthy goal, and probably a prerequisite for building the docs via CI.

There are no C++ builds (that wouldn't be generally useful). The Python builds are done by the conda-forge CI, so that's not here.