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

add basic sphinx docs build using apidoc #50

Merged
merged 4 commits into from
Sep 12, 2024

Conversation

sarnold
Copy link

@sarnold sarnold commented Sep 10, 2024

  • update .gitignore and .gitchangelog.rc and (re)generate new changelog
  • add sphinx docs build using apidoc extension and readme/changelog symlinks
  • rst apidoc modules are auto-generated and are in .gitignore along with the generated html dir
  • add dependencies to packaging and add docs/changes cmds to tox file. Includes a tox extension for shared tox environments; the new tox commands are an example of this => 4 cmds using one tox env.

* update .gitignore and .gitchangelog.rc and (re)generate new changelog
* add sphinx docs build using apidoc extension and readme/changelog
  symlinks
* rst apidoc modules are auto-generated and are in .gitignore
  along with the generated html dir
* add dependencies to packaging and add docs/changes cmds to tox file.
  Includes a tox extension for shared tox environments; the new tox
  commands are an example of this => 4 cmds using one tox env

Signed-off-by: Stephen Arnold <nerdboy@gentoo.org>
@sarnold
Copy link
Author

sarnold commented Sep 10, 2024

Note my usual approach to docs is a workflow to build/push docs to gh-pages branch for pull-requests, and "release" docs in the release workflow. You should probably make the orphan gh-pages branch as shown here. So the sphinx workflow creates html artifacts and deploys to gh-pages while the docs section of release workflow pushes docs with a release version.

* cleanup docs config, remove dicey sphinx_git extension
* switch readme badge, download wheel artifacts to single directory

Signed-off-by: Stephen Arnold <nerdboy@gentoo.org>
* also cleanup sphinx workflow

Signed-off-by: Stephen Arnold <nerdboy@gentoo.org>
Signed-off-by: Stephen Arnold <nerdboy@gentoo.org>
@sarnold
Copy link
Author

sarnold commented Sep 11, 2024

aaaand I did not want this to fall through the giant PR cracks, so the package versioning bits are now using setuptools_scm so after building locally it looks like this:

$ pip install pyre2 --pre --force-reinstall --prefer-binary -f dist/
Looking in links: dist/
Processing ./dist/pyre2-0.3.7.dev37+gba4931b.d20240911-cp311-cp311-linux_x86_64.whl
Installing collected packages: pyre2
  Attempting uninstall: pyre2
    Found existing installation: pyre2 0.3.6
    Uninstalling pyre2-0.3.6:
      Successfully uninstalled pyre2-0.3.6
Successfully installed pyre2-0.3.7.dev37+gba4931b.d20240911

@andreasvc andreasvc merged commit aed0536 into andreasvc:master Sep 12, 2024
21 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants