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

Documentation for pelicanconf.yaml is scattered around and incomplete #90

Open
sebbASF opened this issue Jul 23, 2023 · 0 comments
Open
Labels
bug Something isn't working documentation Improvements or additions to documentation

Comments

@sebbASF
Copy link
Contributor

sebbASF commented Jul 23, 2023

There does not appear to be a definitive document that describes the contents of pelicanconf.yaml.
There are several partial documents, but these are not complete:

Note that neither of them describe what the site/index entry is for.
Nor is the new postrun feature documented.

Given that the file is processed by buildsite.py in this repo, it would seem sensible to document the syntax here.
For example by creating a same yaml file with all the possible entries.
This could even be used in unit tests.

@sebbASF sebbASF added bug Something isn't working documentation Improvements or additions to documentation labels Jul 23, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant