From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: Eli Zaretskii Newsgroups: gmane.emacs.devel Subject: Re: Proposal: Include css for docs in emacs repo Date: Tue, 03 Dec 2024 15:02:30 +0200 Message-ID: <86a5dc3ont.fsf@gnu.org> References: Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="8784"; mail-complaints-to="usenet@ciao.gmane.io" Cc: emacs-devel@gnu.org To: Daniel Radetsky Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane-mx.org@gnu.org Tue Dec 03 14:03:27 2024 Return-path: Envelope-to: ged-emacs-devel@m.gmane-mx.org Original-Received: from lists.gnu.org ([209.51.188.17]) by ciao.gmane.io with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.92) (envelope-from ) id 1tISYp-000239-Hu for ged-emacs-devel@m.gmane-mx.org; Tue, 03 Dec 2024 14:03:27 +0100 Original-Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1tISXz-0003fW-Hs; Tue, 03 Dec 2024 08:02:35 -0500 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1tISXy-0003fJ-17 for emacs-devel@gnu.org; Tue, 03 Dec 2024 08:02:34 -0500 Original-Received: from fencepost.gnu.org ([2001:470:142:3::e]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1tISXx-0004C1-Ny; Tue, 03 Dec 2024 08:02:33 -0500 DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=gnu.org; s=fencepost-gnu-org; h=References:Subject:In-Reply-To:To:From:Date: mime-version; bh=O1bv12XvnyBsPf19kLwPdLdnFSyMv10YfpRNidFB348=; b=ZgmWEnLOefnA EXA8vP+2KG6v5aJswrQKWb73XgyW/GJ8Y6Mua2J+cZdf6bFKHf/ExLUPdyOhcZKcKb6FYbufPp4hG T0JDIQWqUbtqAFJCq2UaYj3xcPaOaBRa/7on4BUV+dzNntPqSqufNygdtlfzA7opjfXk+WYeQAufc 7VQvvDiBSJDJmn/hzFw5RFIvhR05D+6c3rLT4JRle70XogNpcX/PHIzq6pqAY64XK9r/dYhF1R9DP 1HsXf2sLkvYC/iGNN9r8BDyoRohOkO4vrLfDdgrAkHIywaTPT98+una3IvLGlAZEN8QFDuwAbEux/ tEFzz8yuFMuKSl9DVC7Sow==; In-Reply-To: (message from Daniel Radetsky on Mon, 2 Dec 2024 19:32:39 -0800) X-BeenThere: emacs-devel@gnu.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: "Emacs development discussions." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: emacs-devel-bounces+ged-emacs-devel=m.gmane-mx.org@gnu.org Original-Sender: emacs-devel-bounces+ged-emacs-devel=m.gmane-mx.org@gnu.org Xref: news.gmane.io gmane.emacs.devel:325983 Archived-At: > Date: Mon, 2 Dec 2024 19:32:39 -0800 > From: Daniel Radetsky > > I would like to build the emacs manuals for local use. This > means the one-page-per-node manuals. Ideally, I'd like to > build them with one command, and generate a self-contained > directory I could chuck somewhere (e.g. under my designated > serve-docs-from-local dir) and be able to browse them just > like I can on the gnu site. > > Even if the docs build itself didn't currently leave > something to be desired, the built docs will contain the > following > > How do you get this? Is that by running the scripts in the admin/ directory, like make-manuals? Those scripts are for generating manuals we upload to the GNU Software Documentation site, they are not for users to generate HTML docs. For the latter purpose, you are supposed to say $ cd doc/emacs && make emacs.html HTML_OPTS='--html --split=node' > Which refers to css not included in the repo itself. I'm not > sure if it's included in any repo. It is part of the Emacs "webpages" repository, which you can browse here: http://web.cvs.savannah.gnu.org/viewvc/emacs/emacs/ > Personally, I just > downloaded the file (and the style.css file it referenced) > off of gnu.org. It would be nice if instead, these 2 files > were placed in a manual-assets/ dir alongside emacs/ elisp/ > and friends, and if the manuals were to reference the > manual.css file contained in this dir with a relative path, > rather than the one at /software/emacs/manual.css. I don't see a need to include this in the Emacs Git repository. The stuff related to the Web documentation is maintained in a separate repository for a reason. > Anyway, I could concievably hack on the manual-generating > scripts myself (especially if the release-process docs were > a little clearer), but it won't actually accomplish my > purpose if we haven't moved the css to the emacs repo. The way these scripts are used is described in admin/make-tarball.txt. You will see there that the produced HTML manuals are moved to the separate webpages repository and sent upstream from there; the file manual.css is part of that repository. So there's no need to mix this with the Emacs sources, because Emacs users are not supposed to produce manuals in the format used for the GNU Documentation web site.