From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from mail-pj1-f42.google.com (mail-pj1-f42.google.com [209.85.216.42]) by mx.groups.io with SMTP id smtpd.web11.7146.1638932204364524618 for ; Tue, 07 Dec 2021 18:56:44 -0800 Authentication-Results: mx.groups.io; dkim=pass header.i=@nuviainc-com.20210112.gappssmtp.com header.s=20210112 header.b=X8O9ZUKM; spf=pass (domain: nuviainc.com, ip: 209.85.216.42, mailfrom: rebecca@nuviainc.com) Received: by mail-pj1-f42.google.com with SMTP id v23so911938pjr.5 for ; Tue, 07 Dec 2021 18:56:44 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=nuviainc-com.20210112.gappssmtp.com; s=20210112; h=subject:to:references:from:message-id:date:user-agent:mime-version :in-reply-to:content-transfer-encoding:content-language; bh=IaWWzqrJ/Ywgso1JNPOdUfrL+YlXyGaLw+Ge/SdiK5U=; b=X8O9ZUKMSA/nU4rSOtsiHblZlylnABvQWXA+PlvYkWsH5FyDuQRkgSVdRda6wU8V5x 5fH/EmV4B9rY37rm4lua6DTU5Pe/SIpQn3/feDcMA6HvYzSu53fpTL7tntAP4k0tXX3P LZWIMpKSU0RazlsSuIiypAqmP/1cBWAL8QUjWWj3L4ZEQaPi8Uf9cOQ2J/VTGWnhwN5f Cx4ZRkHyy9RPgwCcfIpwsmUJFIYH5e3anS8AQbQfwRd1flfFu5n55kS9cqQGVjvS8upi fXXf/bUS3qICUgRyQYImRcAzKC9JTRKXC+93FgFXN6doKGO4ogWcnz/g3qWK5qt8R/0X 4vUg== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=x-gm-message-state:subject:to:references:from:message-id:date :user-agent:mime-version:in-reply-to:content-transfer-encoding :content-language; bh=IaWWzqrJ/Ywgso1JNPOdUfrL+YlXyGaLw+Ge/SdiK5U=; b=U+Rsuu+jdKzYCr5toviNJNlhzs9bPEy/ZfUKSele/8/7UG5K+UsyITGht0vmtyUoGr Yd9wlEyRawNTqHiZbzWUPn5g9GIbuga1M3wiU7tnvNvcC/OSB+Sx/AnbJuKvSy8oW1sP R8ael6xx8fXoTLHPrGw504gy9ka0Psh+vGGqdWixmWJ3nnMyr5W0ffO6ugzkxkLpfwpl Osqk6GCloVF/xtkdKQQp65UrhqgedWVSJ2eIoq4XKSL6iyLuSjRMvZOb2ZDkWZzMBSyz PI/ppIIDtRmoYHfNPXg30tQrBtvriQlEprTB2/5+t8e0JBzH0VDc2C/3IdZIInUy3L2i 4HIg== X-Gm-Message-State: AOAM533QR/WutEnZCXDU3gHeSVgxi6rJipmQzCqIg1txRT3oiafk5FIs LptIQLDExroRhGLtlIOW1dVIDg== X-Google-Smtp-Source: ABdhPJyx4dSnHJY0QKpn+RxFNjkgF39EeebAhRTjGMu6eRFpO8dw2tX4lo6HyfcBvmNSOY6/N7Wv3A== X-Received: by 2002:a17:90a:9a8e:: with SMTP id e14mr3778553pjp.231.1638932203890; Tue, 07 Dec 2021 18:56:43 -0800 (PST) Return-Path: Received: from ?IPv6:2601:681:4300:69e:9e7b:efff:fe2b:884c? ([2601:681:4300:69e:9e7b:efff:fe2b:884c]) by smtp.gmail.com with ESMTPSA id f8sm1223698pfv.135.2021.12.07.18.56.42 (version=TLS1_3 cipher=TLS_AES_128_GCM_SHA256 bits=128/128); Tue, 07 Dec 2021 18:56:43 -0800 (PST) Subject: Re: [edk2-devel] EDK2 doxygen documentation - adding docs for stable tags? To: devel@edk2.groups.io, michael.d.kinney@intel.com, "rebecca@bsdio.com" References: <30cc16f7-0804-7e16-ba78-089b6d338449@bsdio.com> <6c97560c-ff39-5488-4ecf-8e0076c43a6d@bsdio.com> From: "Rebecca Cran" Message-ID: Date: Tue, 7 Dec 2021 19:56:42 -0700 User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:78.0) Gecko/20100101 Thunderbird/78.13.0 MIME-Version: 1.0 In-Reply-To: Content-Type: text/plain; charset=utf-8; format=flowed Content-Transfer-Encoding: 7bit Content-Language: en-US I have a doxyfile at https://bsdio.com/edk2/docs/master.doxyfile which generates it. I run "doxygen ../master.doxyfile" from the root of an edk2 clone. -- Rebecca Cran On 12/5/21 12:09 AM, Michael D Kinney wrote: > Rebecca, > > I like that combined version. > > How did you package them together? > > Mike > >> -----Original Message----- >> From: devel@edk2.groups.io On Behalf Of Rebecca Cran >> Sent: Saturday, December 4, 2021 8:31 PM >> To: Kinney, Michael D ; devel@edk2.groups.io >> Subject: Re: [edk2-devel] EDK2 doxygen documentation - adding docs for stable tags? >> >> Thanks. Would it be possible to have all the packages together, like >> https://bsdio.com/edk2/docs/master/index.html (ignoring that the page >> has information about Dynamic AML Generation!)? >> >> >> I'm not sure if we need to include the cross-referenced source files >> like mine does, but it might be nice. >> >> >> -- >> Rebecca Cran >> >> >> On 12/4/21 21:01, Kinney, Michael D wrote: >>> Hi Rebecca, >>> >>> Here is a first pass at publishing all the package documents on GitHub Pages. >>> >>> https://mdkinney.github.io/edk2/index.html >>> >>> I have a GitHub Action that pulls the code from an edk2 repo for a specific >>> branch/tag/sha, installs doxygen, generates the HTML documentation for >>> all packages, and publishes the HTML content to a gh-pages branch. GitHub >>> deploys a new version of the web pages each time there is a push to the >>> gh-pages branch. >>> >>> I had to make a couple small fixes to PackageDocumentTools. I will enter >>> a BZ and get those reviewed. The branch with those fixes are here: >>> >>> https://github.com/mdkinney/edk2/tree/Bug_xxx_PackageDocumentationToolFixes >>> https://github.com/mdkinney/edk2/commit/e3eb394ea52621dc02e45d4f78f319cfeb0da68f >>> >>> The GitHub Action is located here: >>> >>> https://github.com/mdkinney/edk2/blob/sandbox/CompareBuild/.github/workflows/PackageDocumentationBuild.yml >>> >>> The deployments page is here. It is updates each time new content is pushed >>> to gh-pages branch. >>> >>> https://github.com/mdkinney/edk2/deployments/activity_log?environment=github-pages >>> >>> This first attempt pushes to a gh-pages branch in my personal fork of the edk2 repo. >>> Given the size of the HTML documentation, I would not recommend that this content be >>> stored in the same repo with the edk2 sources. I would recommend creating a new >>> repo in the tianocore-docs org that would host the GitHub action and can fetch a >>> branch/tag/sha from tianocore/edk2 to publish package documentation in the >>> tianocore-docs org repository. >>> >>> Please review the results and compare to your previous work to see if this is >>> an equivalent replacement. >>> >>> The GitBook documents that are also hosted in tianocore-docs org support publishing >>> multiple releases and a draft release of each document by adding a top level >>> directory to gh-pages. We could do the same for package documentation by >>> having a weekly publication of the draft based on latest tianocore/edk2/master. >>> And we could generate a released version of the package documentation >>> when a new stable-tag is added to tianocore/edk2. >>> >>> Thanks, >>> >>> Mike >>> >>>> -----Original Message----- >>>> From: Kinney, Michael D >>>> Sent: Wednesday, December 1, 2021 9:02 AM >>>> To: devel@edk2.groups.io; rebecca@bsdio.com; Kinney, Michael D >>>> Subject: RE: [edk2-devel] EDK2 doxygen documentation - adding docs for stable tags? >>>> >>>> Hi Rebecca, >>>> >>>> It does not push to gitbook server. It is pushed to web pages hosted by GitHub. >>>> >>>> It uses gitbook tools to process MD files into published PDF, MOBI, HTML. >>>> >>>> For example, the EDK II Build Specification has repo in GitHub: >>>> >>>> https://github.com/tianocore-docs/edk2-BuildSpecification >>>> >>>> And the HTML version of the draft revision of this spec is published here: >>>> >>>> https://tianocore-docs.github.io/edk2-BuildSpecification/draft/ >>>> >>>> These are the web pages associated with tianocore-docs org. >>>> >>>> Thanks, >>>> >>>> Mike >>>> >>>>> -----Original Message----- >>>>> From: devel@edk2.groups.io On Behalf Of Rebecca Cran >>>>> Sent: Wednesday, December 1, 2021 8:52 AM >>>>> To: Kinney, Michael D ; devel@edk2.groups.io >>>>> Subject: Re: [edk2-devel] EDK2 doxygen documentation - adding docs for stable tags? >>>>> >>>>> From what I can see, the tianocore-docs actions push to gitbooks, not >>>>> tianocore.org? >>>>> >>>>> I don't think gitbooks will work for the doxygen pages. >>>>> >>>>> >>>>> -- >>>>> >>>>> Rebecca Cran >>>>> >>>>> >>>>> On 11/30/21 20:21, Kinney, Michael D wrote: >>>>>> Hi Rebecca, >>>>>> >>>>>> This is a good idea. We use GitHub Actions to publish the EDK II Specifications >>>>>> to a web page hosted as part of the documents GitHub repo. >>>>>> >>>>>> I think we can do something similar for generating and publishing the doxygen >>>>>> generated web content for the edk2 packages. I think a manually triggered >>>>>> GitHub action in a repo in tianocore-docs organization might be a good place >>>>>> to do this so all document publication activities are under that same org. >>>>>> The GitHub action can take a branch or tag or sha of the edk2 repo as input >>>>>> to generate the doxygen documentation. >>>>>> >>>>>> Best regards, >>>>>> >>>>>> Mike >>>>>> >>>>>>> -----Original Message----- >>>>>>> From: devel@edk2.groups.io On Behalf Of Rebecca Cran >>>>>>> Sent: Tuesday, November 9, 2021 3:20 PM >>>>>>> To: devel@edk2.groups.io; discuss@edk2.groups.io >>>>>>> Subject: [edk2-devel] EDK2 doxygen documentation - adding docs for stable tags? >>>>>>> >>>>>>> I've been hosting the Doxygen documentation for EDK2 at >>>>>>> https://bsdio.com/edk2/docs for a few years now. I previously had >>>>>>> versions for master, UDK2015, UDK2017, UDK2018 etc. but since migrating >>>>>>> my web server dropped everything except master. >>>>>>> >>>>>>> >>>>>>> I was wondering if people are finding it useful, and if so whether >>>>>>> they'd like me to generate documentation for each stable tag too? >>>>>>> >>>>>>> >>>>>>> Personally, _I_ find the web-based version (as opposed to a >>>>>>> locally-generated version) useful for the search feature -- being able >>>>>>> to quickly find the documentation for a certain function. >>>>>>> >>>>>>> >>>>>>> -- >>>>>>> >>>>>>> Rebecca Cran >>>>>>> >>>>>>> >>>>>>> >>>>>>> >>>>>>> >>>>>>> >>>>> >>>>> >> >> >> > > > > >