Skip to content

Add documentation build script, fix build warning, and update docs on building docs#584

Merged
mfisher87 merged 9 commits intogeojupyter:mainfrom
mfisher87:local-docs-build
Apr 1, 2025
Merged

Add documentation build script, fix build warning, and update docs on building docs#584
mfisher87 merged 9 commits intogeojupyter:mainfrom
mfisher87:local-docs-build

Conversation

@mfisher87
Copy link
Member

@mfisher87 mfisher87 commented Mar 31, 2025

Description

Local builds were failing because of a warning thrown by autodoc because jupytergis_lab was not installed, so GISDocument couldn't be found by autodoc. Edited environment-docs.yml to support this.

Also, the documentation documentation (:smile:) was suggesting using make, when we don't have a Makefile. I added a script instead and updated the docs correspondingly.

Checklist

  • PR has a descriptive title and content.
  • PR description contains references to any issues the PR resolves, e.g. Resolves #XXX.
  • PR has one of the labels: documentation, bug, enhancement, feature, maintenance
  • Checks are passing.
    Failing lint checks can be resolved with:
    • pre-commit run --all-files
    • jlpm run lint

📚 Documentation preview: https://jupytergis--584.org.readthedocs.build/en/584/
💡 JupyterLite preview: https://jupytergis--584.org.readthedocs.build/en/584/lite

Previously it was throwing a warning, which was being ignored. We should
not ignore warnings :)
It also cleans up because a previous build output can cause the build to
fail.
@mfisher87 mfisher87 added documentation Improvements or additions to documentation maintenance Fixing lint errors, changing project metadata, changing tooling, changing dependencies, etc. labels Mar 31, 2025
@github-actions
Copy link
Contributor

Binder 👈 Launch a Binder on branch mfisher87/jupytergis/local-docs-build

@mfisher87 mfisher87 changed the title Update contributors documentation for building documentation Add documentation build script, fix build warning, and update docs on building docs Mar 31, 2025
@mfisher87
Copy link
Member Author

Looks like I broke RTD build, returning to draft


warning  libmamba You are using 'pip' as an additional package manager.
    Be aware that packages installed with 'pip' are managed independently from 'conda-forge' channel.
Installing pip packages: ../python/jupytergis_lab
  error: subprocess-exited-with-error
  
  × Preparing metadata (pyproject.toml) did not run successfully.

@mfisher87 mfisher87 marked this pull request as draft March 31, 2025 21:06
@github-actions
Copy link
Contributor

github-actions bot commented Mar 31, 2025

Integration tests report: appsharing.space

@mfisher87 mfisher87 marked this pull request as ready for review March 31, 2025 22:27
@mfisher87
Copy link
Member Author

Figured it out. Can specify the Python modules as dependencies in environment-docs.yml but they also depend on the javascript packages. So our build needs to do the jlpm build steps before creating the docs environment. Then the docs environment can be created in one step. The local build also requires this. I updated the docs accordingly!

#585 to try and make the python packages' dependencies more self-contained.

@mfisher87
Copy link
Member Author

Would like to hear your feedback @YaoTingYao ! I don't like that this makes our instructions a bit more complicated, but I think the best course is to accept that until we can figure out how to make our Python package builds more self-contained (#585)

Copy link
Member

@martinRenou martinRenou left a comment

Choose a reason for hiding this comment

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

Thanks!

@mfisher87 mfisher87 merged commit edec31d into geojupyter:main Apr 1, 2025
14 checks passed
@mfisher87 mfisher87 deleted the local-docs-build branch April 1, 2025 13:53
HaudinFlorence pushed a commit to HaudinFlorence/jupytergis that referenced this pull request Jan 28, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation maintenance Fixing lint errors, changing project metadata, changing tooling, changing dependencies, etc.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants