Skip to content

Conversation

@shivaahir158
Copy link
Collaborator

@shivaahir158 shivaahir158 commented Oct 16, 2024

Motivate of the pull request

  • To address an existing issue. If so, please provide a link to the issue:
  • Breaking new feature. If so, please describe details in the description part.

Describe the technical details -

An initial setup for integrating readthedocs into RPE repository.
It includes the configuration files to generate and host project documentation using Sphinx and readthedocs.

  1. Added a .readthedocs.yml configuration file to define the readthedocs build process.
  2. Created and structured the docs/ directory for Sphinx-based documentation.
  3. Added an initial index.rst file with sections for Introduction, History, GUI Design and Technology Choices, and Contents. (Mustafa and team can pick it up from here)
  4. Set up conf.py for Sphinx to use the Read the Docs theme.
  5. Updated requirements.txt to include Sphinx and the needed dependencies for building the documentation.

Which part of the code base require a change

  • Frontend:
  • Backend:
  • Library: <Specify the library name, e.g. npm packages>
  • Plug-in: <Specify the plugin name, e.g. Webpack, jtest>
  • Documentation https://rapid-power-estimator5.readthedocs.io/en/latest/ (sample content that has been added so far)
  • Regression tests
  • Continuous Integration (CI) scripts

Impact of the pull request

  • Require a change on Quality of Results (QoR)
  • Break backward-compatibility. If so, please list who may be influenced.

@codecov
Copy link

codecov bot commented Oct 16, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 69.46%. Comparing base (3aa9e36) to head (ef63b9f).

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #240   +/-   ##
=======================================
  Coverage   69.46%   69.46%           
=======================================
  Files         110      110           
  Lines        8607     8607           
=======================================
  Hits         5979     5979           
  Misses       2628     2628           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@shivaahir158 shivaahir158 changed the title readthedocs readthedocs for RPE Oct 16, 2024
@shivaahir158 shivaahir158 self-assigned this Oct 16, 2024
@shivaahir158 shivaahir158 marked this pull request as ready for review October 16, 2024 19:52
@ravikiranchollangi ravikiranchollangi merged commit 6e6cdd8 into main Oct 16, 2024
11 checks passed
@ravikiranchollangi ravikiranchollangi deleted the readthedocs branch October 16, 2024 22:50
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