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 instructions to build documentation #822

Merged
merged 9 commits into from
Dec 29, 2023
Merged

Add instructions to build documentation #822

merged 9 commits into from
Dec 29, 2023

Conversation

dmlls
Copy link
Contributor

@dmlls dmlls commented Oct 27, 2022

Pull request

This PR adds a README.md in the docs directory with a short explanation on how to build the docs. This might be especially useful for people coming from non-technical backgrounds in order to be able to contribute to the documentation.

How Has This Been Tested?

The requirements have been frozen by installing the latest versions of sphinx-argparse and pdfminer.six and running pip freeze > requirements.txt.

Afterwards, I've created a virtual environment, installed the requirements and checked that the build was successful.

Checklist

  • I have read CONTRIBUTING.md.
  • I have added a concise human-readable description of the change to CHANGELOG.md.
  • I have tested that this fix is effective or that this feature works.
  • I have added docstrings to newly created methods and classes.
  • I have updated the README.md and the readthedocs documentation. Or verified that this is not necessary.

@dmlls dmlls marked this pull request as ready for review October 27, 2022 14:01
@pettzilla1
Copy link
Contributor

Hi are the requirements listed just all the current requirements of the package or have additional requirements been added ?

@dmlls
Copy link
Contributor Author

dmlls commented Oct 28, 2022

Hi @pettzilla1, no additional requirements have been added.

As mentioned above, I installed sphinx-argparse and pdfminer.six, which are required to build the docs. The rest of the modules are just dependencies of those.

@pietermarsman
Copy link
Member

Hi @dmlls,

Thanks for this setup! I've rewrote the readme in active phrases and will merge it now.

@pietermarsman pietermarsman added this pull request to the merge queue Dec 29, 2023
Merged via the queue into pdfminer:master with commit 7715f88 Dec 29, 2023
10 checks passed
@dmlls dmlls deleted the docs/add-build-instructions branch December 30, 2023 12:42
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.

3 participants