-
Notifications
You must be signed in to change notification settings - Fork 9
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Remove old code and documentation, adding a doc placeholder. #42
Conversation
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.
Please add doc/build to gitignore - we don't want all that autogenerated stuff in the source tree. Take a look at Plaso's readthedocs and sphinx configs for example.
deleted the autogenerated docs, and changed gitignore |
can you review again? |
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.
The sphinx config doesn't actually generate any useful docs any more - was that what you wanted to do here? It also refers to "l2t scaffolder" which doesn't exist (yet). Can you please make the sphinx config consistent and some placeholder text to index.rst calling out that there's no documentation.
Alternatively, you could set up the sphinx config to generate autodoc, in a similar manner to Plaso etc.
yes, that was the intention, the intention of this PR was mainly to delete old files, not to really setup sphinx for document creation. The intent was to do that in another PR. |
and yes, I changed the index.rst file a bit to indicate that there isn't any documentation ATM |
also changed the name and description of the PR to reflect my actual intention |
Removing older code that is no longer needed as well as re-generating the documentation with a placeholder (as in really delete the documentation)