Reorganize & clarify documentation structure #50
Merged
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
|
@zoziha on this and other PRs, I'm requesting your review because GitHub reports that you have contributed the most to this repository so I assume you're the most interested and/or have the most at stake. Others are welcome to review or someone can let me know if it's ok to merge without review. I did merge one or two trivial PRs without review. |
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.
The primary goal of this PR is to save time for newcomers looking for Fortran-lang/fftpack's documentation. This PR does the following:
doc/README.mdfile thata. Directs the reader to the GitHub Pages documentation deployed in HTML form by this repository's CI scripts,
b. Provides a
fordcommand for generating the same HTML files locally,c. Clarifies the structure and purpose of the files in the
doc/subdirectory,legacy/subdirectory,emailmetadata tag in thefordproject file.The main point is to divert anyone looking for readily consumable documentation in the
doc/subdirectory unless they're interested in the legacy documentation.