Skip to content

Upgrade Docs to Newer Sphinx Version to Allow for Two Character Searches Covering Two Character x64dbg Commands #3700

@utkonos

Description

@utkonos

I will give this a try myself with a PR when I have some time to dig into it and make sure that any other changes that would go along with it are also made correctly. Just opening this issue to make a note of it. And if I am wrong in any way here, please correct me.

The version currently in use, sphinx==1.5.6, does not handle two character search terms. I am not entirely familiar with Sphinx details, so I will need to get up to speed. But the latest version can handle two character searches in my testing on the project's own docs site about itself.

The reason this is useful is there are a set of two character commands that are common in x64dbg scripting and in the console box in the debugger. If a beginner start by looking at example scripts in the x64dbg/Scripts repo, and then pastes one of the two-character commands into the current docs, the result is blank. I am assuming that using a newer version will allow for indexing similar to what is seen on Sphinx's own docs site, and would then show relevant docs in a search.

sphinx==1.5.6

First script in the examples repo has bc and other two-char commands:
Image

Docs search result:
Image

It's there, but not indexed:
Image

Sphinx 8.2.3:
Image

There will be a bunch of garbage in the results, but that's probably a good trade-off for a newbie, vs getting nothing.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions