Skip to content

DOC: update doc geometry_area_perimeter #1489

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

Merged
merged 2 commits into from
Apr 25, 2025
Merged

DOC: update doc geometry_area_perimeter #1489

merged 2 commits into from
Apr 25, 2025

Conversation

myl-dvl
Copy link
Contributor

@myl-dvl myl-dvl commented Apr 21, 2025

@myl-dvl myl-dvl marked this pull request as ready for review April 21, 2025 16:22
@snowman2
Copy link
Member

Thanks @myl-dvl 👍. If you have a moment to share a screenshot of the docstrings rendered that would be helpful. Otherwise, I will try to build the docs later before merging.

@myl-dvl
Copy link
Contributor Author

myl-dvl commented Apr 22, 2025

Thanks @myl-dvl 👍. If you have a moment to share a screenshot of the docstrings rendered that would be helpful. Otherwise, I will try to build the docs later before merging.

hum ok, I'm not sure if I need to build the all doc for that or if there is a way to get only the rendering of this snippet.
You want the screenshot in the PR or somewhere else ?

@snowman2
Copy link
Member

You want the screenshot in the PR or somewhere else ?

Here in the PR would be great.

@myl-dvl
Copy link
Contributor Author

myl-dvl commented Apr 23, 2025

Hi, I'm currently stuck trying to build the documentation.
When I try make install-docs It does not recognize "install-docs" as a correct build option.
In fact, no option from CONTRIBUTING.md is listed in my sphinx :

Sphinx v8.2.3
Please use `make target' where target is one of
  html        to make standalone HTML files
  dirhtml     to make HTML files named index.html in directories
  singlehtml  to make a single large HTML file
  pickle      to make pickle files
  json        to make JSON files
  htmlhelp    to make HTML files and an HTML help project
  qthelp      to make HTML files and a qthelp project
  devhelp     to make HTML files and a Devhelp project
  epub        to make an epub
  latex       to make LaTeX files, you can set PAPER=a4 or PAPER=letter
  text        to make text files
  man         to make manual pages
  texinfo     to make Texinfo files
  gettext     to make PO message catalogs
  changes     to make an overview of all changed/added/deprecated items
  xml         to make Docutils-native XML files
  pseudoxml   to make pseudoxml-XML files for display purposes
  linkcheck   to check all external links for integrity
  doctest     to run all doctests embedded in the documentation (if enabled)
  coverage    to run coverage check of the documentation (if enabled)
  clean       to remove everything in the build directory

I'm on Windows, maybe it is linked.
I did a python -m pip install -r requirements-docs.txt previously that was not in the documentation but felt like required (because no make command in Windows).

Any idea on what's wrong ?

Ps: Do I need to open an issue ?

@snowman2
Copy link
Member

It is designed for Linux users.

The html command from what you have listed should do it I believe.

@myl-dvl
Copy link
Contributor Author

myl-dvl commented Apr 25, 2025

Here is the screenshot. Should we update the doc for windows users ? Maybe just add a note.
Thank you for your help on this one.

image

@snowman2
Copy link
Member

Should we update the doc for windows users ?

That would be helpful.

@snowman2 snowman2 merged commit 38a7f8a into pyproj4:main Apr 25, 2025
@snowman2
Copy link
Member

Thanks @myl-dvl 👍

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.

geometry_area_perimeter limitations not documented
3 participants