Hacktoberfest 2026: the issues maintainers tagged for October, open and beginner-friendly. Browse Hacktoberfest issues

Sphinx packages / admin

Open
#20 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
25/100
Issue type
Documentation
Clarity
Needs clarification
Activity status
Stale
Domain
documentation

Research direction

The issue does not name a file, test, or entry point. Review the existing Engine Yard Docs pages for Unix packages and Sphinx-related guidance, then determine whether package versions and recommended index and daemon practices are documented. Done means adding a clear, supported reference that addresses the listed packages and questions.

Written by the indexing model from the issue text.

Description

I see the following are available to install under Unix packages:

app-accessibility/SphinxTrain
app-accessibility/sphinx2
app-misc/sphinx

Are there more details on these packages, ie. version? We have been using Sphinx 2.0.2 locally as 2.0.1 beta has known problems on OS/X. Also, do you have any recommended practices for Sphinx index and daemon tasks? Thanks.

Dominant language
JavaScript
Stars
26
Forks
11
PR merge metrics
No merged PRs in 30d

Getting set up

This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.

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.

More from engineyard/ey-docs

All issues in engineyard/ey-docs

Similar issues

More JavaScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.