This repository has been archived by the owner on Oct 15, 2022. It is now read-only.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@vigzmv this is a great start -- the structure of the Django docs clearly doesn't lend itself to being parsed for classes/methods/attributes/etc
I have another idea though, what about downloading the HTML offline docs (instead of several files) and iterating over the Index?
It seems that most entries in the index indicate if they are a class, method, attribute or function in parenthesis. By scraping those and using the css classes on the page, I think we could reliably parse out all the methods, classes, attributes and functions from the docs?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
ideally then we would have more context when creating the output and we could more cleverly create redirects to handle queries like "django AddField class", "django add method" etc.
Of course that's not necessary for Version 1, but it may help to make the Fathead more flexible
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes. That's a good idea. I will working to improve this fathead.