linkedin / linkedin/pygradle

Split Sphinx into its own plugin

Open
#93 6 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Java
Stars
603
Forks
142
PR merge metrics
No merged PRs in 30d

Description

I intend to experiment with this but I wanted your opinion. I have a huge number of java projects i want to add pygradle to because I want to position Sphinx as our language independent code documentation system and i love pygradles dependency management system. The issue is that every time you do a sphinx compile it executes the project install task. Before i waste any time trying to rip things apart and play, off the cuff, what would happen if i pulled the sphinx tasks off into their own plugin, referenced them back into the sdist plugin like before, and tried to execute them independently without the venv and install tasks running? My gut feeling is im going to screw something up in the dependency resolution system but i wanted to ask first before wasting time on it.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the existing Sphinx tasks and the sdist plugin, then trace how the venv, install, and dependency-resolution tasks are connected. Determine whether Sphinx tasks can run independently without those tasks, and verify that dependency resolution still works; the issue names no files or tests.

Written by the indexing model from the issue text.

Assessment

Tech stack
java, python
Domain
build-system
Issue type
Refactor
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.