Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs links and GHA #2146

Merged
merged 3 commits into from
Apr 23, 2021
Merged

docs links and GHA #2146

merged 3 commits into from
Apr 23, 2021

Conversation

loriab
Copy link
Member

@loriab loriab commented Apr 5, 2021

Description

technical improvements to docs, part 2

Todos

  • bug fix and energy change these changes to RI basis for sto-3g, sto-6g, 3-21g https://github.com/psi4/psi4/pull/2146/files#diff-343949bff4fe0802df72641969d7aceb07a122625e5b70d95c6e2757e4ee3c92R435 now refer to a real basis set, so in practice, calcs will use the svp now rather than the qzvpp. tests sapt-ecp and nbody-levels have been tweaked to pass. this will lead to real numbers changes in psi4 runs, though hopefully they'll be a little quicker, too. apparently hunting docs ref errors can fix real bugs
  • docs now pass sphinx-build -b linkcheck, meaning that all the external hyperlinks in the docs are ok or redirect, none broken (except for a few that are excused in conf.py.in). 300 -> 0 broken links!
  • started on the sphinx-build -b html -n nitpicky mode. 1300 -> 1000
  • fixed all the docstring of psi4.core.PyCapsule.dfh:: WARNING: py:class reference target not found: psi::DFHelper

Checklist

  • Tests added for any new features
  • full tests pass

Status

  • Ready for review
  • Ready for merge SQUASH

@loriab loriab changed the base branch from master to gha-master April 5, 2021 23:05
@github-actions
Copy link

github-actions bot commented Apr 6, 2021

Hello world ! 👋

@github-actions
Copy link

github-actions bot commented Apr 6, 2021

An automated commit has been issued to your PR branch updating samples/. Be sure to git pull --rebase origin <pr-branch> locally. 👋

@github-actions
Copy link

github-actions bot commented Apr 6, 2021

An automated commit has been issued to your PR branch updating samples/. Be sure to git pull --rebase origin <pr-branch> locally. 👋

loriab pushed a commit to psi4/psi4docs that referenced this pull request Apr 6, 2021
@github-actions
Copy link

github-actions bot commented Apr 6, 2021

An automated commit has been issued to your PR branch updating samples/. Be sure to git pull --rebase origin <pr-branch> locally. 👋

loriab added a commit to psi4/psi4docs that referenced this pull request Apr 6, 2021
@github-actions
Copy link

github-actions bot commented Apr 6, 2021

An automated commit has been issued to your PR branch updating samples/. Be sure to git pull --rebase origin <pr-branch> locally. 👋

@github-actions
Copy link

github-actions bot commented Apr 6, 2021

@loriab
Based upon a build of the documentation target (make sphinxman locally with Sphinx installed at CMake configuration time):

  • an automated commit has been issued to your PR branch
    • this updates samples/ based on tests/
    • if objectionable, make changes and force push your local branch, but you can't avoid the update forever
    • usually, git pull --rebase origin <prbranch> to synchronize your local branch with GH
  • an automated pull request has been issued to the docs website repo previewing <objdir>/doc/sphinxman/html

loriab added a commit to psi4/psi4docs that referenced this pull request Apr 7, 2021
@loriab loriab changed the base branch from gha-master to master April 8, 2021 01:31
@loriab loriab changed the base branch from master to gha-master April 8, 2021 17:56
loriab added a commit to psi4/psi4docs that referenced this pull request Apr 8, 2021
loriab added a commit to psi4/psi4docs that referenced this pull request Apr 8, 2021
@github-actions
Copy link

github-actions bot commented Apr 8, 2021

@loriab
Based upon a build of the documentation target (locally, make sphinxman with Sphinx installed at CMake configuration time):

  • an automated pull request [Auto] Docs from 2146 psi4docs#1 has been issued to the docs website repo
    • this previews docs changes from <objdir>/doc/sphinxman/html
    • look over your docs changes at checks, deploy-preview. Edit your PR branch here as needed; no further action on auto PR required.
    • alternately, look over your docs changes locally by downloading sphinxman-html zip file from Archive list in Action run

loriab added a commit to psi4/psi4docs that referenced this pull request Apr 9, 2021
@github-actions
Copy link

github-actions bot commented Apr 9, 2021

@loriab
Based upon a build of the documentation target (locally, make sphinxman with Sphinx installed at CMake configuration time):

  • an automated pull request [Auto] Docs from 2146 psi4docs#1 has been issued to the docs website repo
    • this previews docs changes from <objdir>/doc/sphinxman/html
    • look over your docs changes at checks, deploy-preview. Edit your PR branch here as needed; no further action on auto PR required.
    • alternately, look over your docs changes locally by downloading sphinxman-html zip file from Archive list in Action run

@loriab loriab added this to the Psi4 1.4 milestone Apr 9, 2021
Copy link
Member

@andysim andysim left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

loriab added a commit to psi4/psi4docs that referenced this pull request Apr 9, 2021
@github-actions
Copy link

github-actions bot commented Apr 9, 2021

@loriab
Based upon a build of the documentation target (locally, make sphinxman with Sphinx installed at CMake configuration time):

  • an automated commit 5aa048b has been issued to your PR branch

    • this updates 4 files in samples/ based on tests/
    • if objectionable, make changes and force push your local branch, but you can't avoid the update forever
    • usually, git pull --rebase origin ghadocs3 to synchronize your local branch with GH
  • an automated pull request [Auto] Docs from 2146 psi4docs#1 has been issued to the docs website repo

    • this previews docs changes from <objdir>/doc/sphinxman/html
    • look over your docs changes at checks, deploy-preview. Edit your PR branch here as needed; no further action on auto PR required.
    • alternately, look over your docs changes locally by downloading sphinxman-html zip file from Archive list in Action run

@loriab loriab changed the base branch from gha-master to master April 9, 2021 18:44
docs 1

docs 2

docs 3

docs 4

docs 5

docs 6

docs 7

docs 8

docs 9

docs 10

docs 11

docs 12

docs 13

docs 14

docs 15

docs 16

bump

docs 17
@loriab loriab merged commit 805b1ae into psi4:master Apr 23, 2021
@loriab loriab deleted the ghadocs3 branch April 23, 2021 01:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants