Skip to content

Add links to the API documentation and man-pages #250

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

Open
kit-ty-kate wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Add links to the API documentation and man-pages #250

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ea08c22
Add links to the API documentation and man-pages
kit-ty-kate Nov 21, 2025
f996543
Fix the content of /doc/api and /doc/man
kit-ty-kate Nov 21, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions Dockerfile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,9 @@ ARG OPAM_GIT_SHA=master
RUN echo ${OPAM_REPO_GIT_SHA} >> /www/opam_git_sha
RUN echo ${BLOG_GIT_SHA} >> /www/blog_git_sha
RUN echo ${OPAM_GIT_SHA} >> /www/doc_git_sha
RUN mkdir -p /www/doc
RUN cp -r /usr/local/share/opam2web/content/doc/api /www/doc/api
RUN cp -r /usr/local/share/opam2web/content/doc/man /www/doc/man
RUN /usr/local/bin/opam-web.sh ${DOMAIN} ${OPAM_REPO_GIT_SHA} ${BLOG_GIT_SHA}
WORKDIR /srv
COPY Caddyfile /etc/caddy/Caddyfile
Expand Down
16 changes: 16 additions & 0 deletions src/o2wDocumentation.ml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -282,4 +282,20 @@ let to_menu ~content_dir =
match srcurl_12 with
| None -> None
| Some u -> Some (u ^ "/index.menu");
};
{
menu_source = "api";
menu_link = Uri.make ~path:"doc/api/" ();
menu_link_text = "API";
menu_link_html = Html.string "API";
menu_item = External;
menu_srcurl = None;
};
{
menu_source = "man";
menu_link = Uri.make ~path:"doc/man/" ();
menu_link_text = "Man pages";
menu_link_html = Html.string "Man pages";
menu_item = External;
menu_srcurl = None;
}]