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

Feature/index page #4615

Merged
merged 9 commits into from Nov 1, 2023
Merged

Feature/index page #4615

merged 9 commits into from Nov 1, 2023

Conversation

f18m
Copy link
Contributor

@f18m f18m commented Oct 31, 2023

Make the index page of Asciidocs more similar to api.zeromq.org landing page, with a list of available documentation pages.

@f18m
Copy link
Contributor Author

f18m commented Oct 31, 2023

With this PR I hope to:

  • make it clear in the landing/index page the version of libzmq referred by the documentation
  • make sure we link each and every .adoc page (some user might forget to add a link in zmq.adoc or even in the Makefile.am at some point)

@f18m
Copy link
Contributor Author

f18m commented Oct 31, 2023

@bluca ,
I noticed that one CI build is failing with:

make[2]: Entering directory '/home/runner/work/libzmq/libzmq/libzmq/zeromq-4.3.6/_build/sub/doc'
echo >../../../doc/__pagelist
/bin/bash: line 1: ../../../doc/__pagelist: Permission denied

seems like only in 1 case the source directory is read-only... would you know why?

@f18m
Copy link
Contributor Author

f18m commented Oct 31, 2023

@bluca , I noticed that one CI build is failing with:

make[2]: Entering directory '/home/runner/work/libzmq/libzmq/libzmq/zeromq-4.3.6/_build/sub/doc'
echo >../../../doc/__pagelist
/bin/bash: line 1: ../../../doc/__pagelist: Permission denied

seems like only in 1 case the source directory is read-only... would you know why?

I probably have fixed this issue by generating the __pagelist file inside the build tree instead of the source tree.
However I'm not 100% confident about CMake build system: how can I obtain the same result as Automake?
Should I move the __pagelist generation into an ancillary script that is then invoked from both CMake and Automake?

@f18m f18m marked this pull request as ready for review October 31, 2023 22:54
@bluca
Copy link
Member

bluca commented Oct 31, 2023

As long as it doesn't break the build, I don't really care if cmake doesn't generate the list, given it's just for the website

@bluca bluca merged commit aa9a2c8 into zeromq:master Nov 1, 2023
62 checks passed
@f18m f18m deleted the feature/index-page branch November 1, 2023 22:38
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.

None yet

2 participants