Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Add README to documentation Index if no other docs #12

Closed
theory opened this issue Mar 28, 2012 · 1 comment · Fixed by #31
Closed

Add README to documentation Index if no other docs #12

theory opened this issue Mar 28, 2012 · 1 comment · Fixed by #31
Assignees
@theory
Labels
bug feature patched
Milestone
v0.20

Comments

@theory
Copy link
Member

theory commented Mar 28, 2012

Quite a few distributions have only one extension and no documentation file other than the README. Authors can get around this by adding the README under the docfile key in the provides section, but it seems silly.

So, add a rule to the indexer such that, if the distribution:

  1. Has only one extension
  2. Has no documentation file for that extension
  3. Has a README

Then automatically index the README as documentation.
@ghost ghost assigned theory Mar 28, 2012
@theory
Copy link
Member Author

theory commented Oct 21, 2012

It looks as though if authors set the docfile key to the README it doesn't show up at all. Example: mongo_fdw 1.0.0. So authors can't work around it. :-(

@theory theory mentioned this issue Oct 21, 2012
Closed
theory added a commit that referenced this issue Feb 7, 2024
@theory
Index README if only doc
95e3199 
And test that fact. Resolves #12.
theory added a commit that referenced this issue Feb 7, 2024
@theory
Index README if only doc
e6e89d9 
And test that fact. Resolves #12.
@theory theory added the patched label Feb 7, 2024
@theory theory mentioned this issue Feb 8, 2024
Merged
theory added a commit that referenced this issue Feb 8, 2024
@theory
Always respect the docfile field
c13c746 
The indexer wasn't really paying attention to the `docfile` field in
`provides` objects, other than to be sure its value was a file to try
to index. Instead is just looked for doc files where the file name was
the same as the extension name. This works okay for distributions that
follow that rule strictly. But many distributions point to the
`README` as the doc file (as mentioned in #12), and others point to
completely different file (as in #10).

So capture much earlier that an extension has pointed to a specific
doc file, and track that relationship throughout the indexing process.
Add test cases to be sure it works.

Resolves #10.
@theory theory closed this as completed in 8fdbe90 Feb 8, 2024
@theory theory mentioned this issue Feb 8, 2024
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@theory theory

Labels
bug feature patched
Projects
None yet
Milestone
v0.20
Development

Successfully merging a pull request may close this issue.

Add README to docs index if no other docs found pgxn/pgxn-api
1 participant
@theory