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

Create qgis-sample-QgsMapRendererSequentialJob.py #2

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

spatialthoughts
Copy link

Hi,

I would like to contribute a few code samples to this repo. Starting with this simple one. I wasn't sure which other files need to be updated - so please let me know required modifications.

Thanks.

@ThomasG77
Copy link
Contributor

Sorry, for the late answer. Currently reorganizing the repo to use Sphinx doc to be able to contribute back to QGIS official content.

I've prepared the structure for your sample at 661ea36
You just need to change the code sample content in file https://github.com/webgeodatavore/pyqgis-samples/blob/sphinx/source/_static/samples/core/qgis-sample-QgsMapRendererSequentialJob.py

The recipe without my preparation would be the following:

  • Use the "sphinx" branch of the repo
  • Edit source/core-group.rst or source/gui-group.rst to check include to the class you want to document is here. Add it if not here
  • Add or update .rst in source/gui-group/ or source/core-group/
  • Add your sample in source/_static/samples/core or source/_static/samples/gui (you may also use source/_static/samples/ui for Qt ui files or source/_static/images for images to illustrate)

Run from the repository root make html considering you have installed sphinx and see the result in build/html/index.html

FYI, I plan to run automated build from Github to publish content.

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