Enable Update_Docs to Scan Subdirectories; Stop Deleting Distro Files; Fix Docs CSS #220
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The changes are not as widespread as it appears, but a large percentage of the code had to be indented Doesn't fully work yet.
This allows for sorting of the entire list, not just parts of it
"sub new" should be followed by a whitespace character, but no necessarily a space
…nup internal comments Script previously would delete extra files in the /doc dir even when users had followed the suggested install procedure and used an alternative docs dir. The distribution directory structure should not be modified if users are installing things the way we suggest.
It looked silly to have heading 3 smaller than the body text. Heading4 is not often used, but it should be defined to avoid the default setting in browsers.
…le.pod The settings in pod2html were preventing proper links from being created. The new settings allow it to properly search the pod directories Updated Example.pod to suggest using a link to identify inherited objects.
krkeegan
added a commit
that referenced
this pull request
Jun 15, 2013
Enable Update_Docs to Scan Subdirectories; Stop Deleting Distro Files; Fix Docs CSS
Merged
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Update_docs can now scan and create html files from pod documents created in subdirectories of lib, such as the Insteon directory. Fixes #199
I disabled the function of update_docs which was deleting files from the distribution folder docs. I have my html_alias2_docs folder outside of the distribution folder like I should, but the script was still deleting files such as download.html in the distro/docs folder. It shouldn't do that. The point of all of this is to only make changes to distro that are actually going to be committed to the repository. This function can be re-enabled later if necessary.
I added a head level 4 to the css and cleaned up head level 3.
While it looks like a lot of changes in the file, there are actually few changes, but a majority of the file had to be indented to allow for an additional foreach loop to rotate through the sub directories.
I am working on the Insteon POD documentation and should have it done in the next day or so.