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

Use README in RTD docs #138

Merged
merged 8 commits into from
Jul 10, 2023
Merged

Use README in RTD docs #138

merged 8 commits into from
Jul 10, 2023

Conversation

AyanSinhaMahapatra
Copy link
Member

No description provided.

arijitde92 and others added 6 commits June 1, 2023 15:02
Made changes in the .readthedocs.yaml to enable format for downloading pdf and epub versions of the documentation and added latex_elements in the conf.py file which generates the pdf without blank pages. The minimum version requirement for sphinx was 6.2.1 which was causing build failure in read the docs, hence changing it 3.3.1 as written in setup.cfg of nexB/aboutcode

Signed-off-by: Arijit De <arijitde2050@gmail.com>
Added PDF and ePub download option for RTD documentation as requested in aboutcode-org/aboutcode#127
Update the following actions:

* actions/checkout
* actions/setup-python

Reference: aboutcode-org/skeleton#75
Signed-off-by: Ayan Sinha Mahapatra <ayansmahapatra@gmail.com>
* Remove skeleton docs
* Use the minimal README in the RTD build

Signed-off-by: Ayan Sinha Mahapatra <ayansmahapatra@gmail.com>
Signed-off-by: Ayan Sinha Mahapatra <ayansmahapatra@gmail.com>
docs/source/index.rst Outdated Show resolved Hide resolved
Reference: readthedocs/sphinx_rtd_theme#1115
Signed-off-by: Ayan Sinha Mahapatra <ayansmahapatra@gmail.com>
@AyanSinhaMahapatra
Copy link
Member Author

See https://purldb.readthedocs.io/en/clean-docs/ for reference.

Signed-off-by: Ayan Sinha Mahapatra <ayansmahapatra@gmail.com>
Copy link
Member

@pombredanne pombredanne left a comment

Choose a reason for hiding this comment

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

LGTM. Thanks!

@AyanSinhaMahapatra AyanSinhaMahapatra merged commit 9cd5dbb into main Jul 10, 2023
@pombredanne pombredanne deleted the clean-docs branch July 10, 2023 15:12
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