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.

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

Fix behavior of Pages in @bibliography blocks #48

Merged
merged 1 commit into from
Oct 23, 2023
Merged

Fix behavior of Pages in @bibliography blocks #48

merged 1 commit into from
Oct 23, 2023

Conversation

goerz
Copy link
Member

@goerz goerz commented Oct 15, 2023

The Pages field now behaves exactly as Pages in @contents and @index blocks: all files are relative to the directory containing the current file.

Also, by popular demand, @__FILE__ is supported to refer to the current file (even though @contents and @index does not support this feature.

Closes #22

@goerz
Copy link
Member Author

goerz commented Oct 15, 2023

This is mostly internal changes, up to a few new sentences in the documentation that clarify the Pages field.

@goerz goerz force-pushed the mg/22-pages branch 5 times, most recently from db4f258 to f9683ed Compare October 16, 2023 02:07
The `Pages` field now behaves exactly as `Pages` in `@contents` and
`@index` blocks: all files are relative to the directory containing the
current file.

Also, by popular demand, `@__FILE__` is supported to refer to the
current file (even though `@contents` and `@index` does not support this
feature.
@goerz
Copy link
Member Author

goerz commented Oct 16, 2023

@kellertuer Can you have a look?

Copy link
Contributor

@kellertuer kellertuer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I can not evaluate the implementation itself, but the design and style looks good to me.

You write a bit skeptical here in the PR about the @__FILE__ not being used in the other blocks. Well, the other ones also do not read their content from Markdown files so a self-reference is not happening there. :)

@goerz
Copy link
Member Author

goerz commented Oct 16, 2023

I got confused about @autodocs. I thought it was also taking .md files in its Pages, but it doesn't, so @__FILE__ doesn't make sense there.

The @content and @index blocks do take .md files, though, no? Those seem like they have the same semantics for Pages as @bibliography, so I think JuliaDocs/Documenter.jl#2301 and JuliaDocs/Documenter.jl#2302 still apply, for consistency.

@goerz
Copy link
Member Author

goerz commented Oct 20, 2023

If there are no further comments, I will merge this sometime this weekend

@goerz goerz merged commit 4fe21f4 into master Oct 23, 2023
10 checks passed
@goerz goerz deleted the mg/22-pages branch October 25, 2023 04:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

About non canonical bibliography inconsistencies (to autodocs)
2 participants