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

generate doc with pandoc in docker #1555

Merged
merged 1 commit into from
Dec 26, 2023
Merged

Conversation

laktak
Copy link
Contributor

@laktak laktak commented Dec 20, 2023

@joelim-work here is the script in its own PR.

You can update the pandoc version but 2.11 was the closest to 2.5 that was mentioned in the existing docs.

Also I would not actually check doc.txt and lf.1 into git as they should be generated during the build step.

Copy link
Collaborator

@joelim-work joelim-work left a comment

Choose a reason for hiding this comment

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

Thanks, the script looks good to me.

I was thinking about introducing this as a CI check similar to go generate (now obsolete), but I'm not 100% sure about this since it will require contributors to either setup Docker, or keep manually fixing the documentation mistakes until the build passes.

Regarding the autogenerated doc.txt and lf.1 files, this was also discussed in #1474, but @gokcehan decided to keep them as there doesn't seem to be a good solution. The main problem is that using go install to build from source won't work if doc.txt doesn't exist.

@gokcehan
Copy link
Owner

I was just using the pandoc installed in my ubuntu 20.04 system, which is quite outdated. I think it is okay to use a newer version or even the latest version. Alternatively, we can also try to use the pandoc version in the latest ubuntu or latest ubuntu-lts releases.

@gokcehan gokcehan merged commit 4882945 into gokcehan:master Dec 26, 2023
4 checks passed
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.

3 participants