public inbox for pbs-devel@lists.proxmox.com
 help / color / mirror / Atom feed
From: Thomas Lamprecht <t.lamprecht@proxmox.com>
To: Proxmox Backup Server development discussion
	<pbs-devel@lists.proxmox.com>, Dylan Whyte <d.whyte@proxmox.com>
Subject: Re: [pbs-devel] [PATCH docs] move custom.css from 'docs/' to 'docs/_static/'
Date: Mon, 14 Sep 2020 09:32:30 +0200	[thread overview]
Message-ID: <7adacf0a-0896-d9fc-83e1-25730830d642@proxmox.com> (raw)
In-Reply-To: <20200911140817.19368-1-d.whyte@proxmox.com>

On 9/11/20 4:08 PM, Dylan Whyte wrote:
> conf.py sets the variable html_static_path to a folder
> named '_static'. This is where sphinx searches for custom
> stylesheets, so before this change, custom.css had no effect.

I sure did have an effect, a `make install` or a `make proxmox-backup-docs`
plus `dpkg -i ./*.deb` should show it also in your build setup, or?

Note, that sphinx outputs more than one render, e.g., latex, html (epub and
some others would be a possibility too), so the `html_static_path` refers
to the html output and I copy it there after the sphinx build of HTML is
finished.

Note also that this patch breaks any build, as the makefile cannot do the copy
any more, that would have been easily caught by testing a single build..
So please, one thing I'd expect people to do before sending patches is at
least a simple build test, a more functional test is naturally also expected
but if it doesn't even build after ones patch is applied it feels like a waste
of reviewers time, which is 100 times more scarce than developer time..

This should not sound to much like scolding, but please ingrain a final build
and quick functional test step before you send any patch it in your workflow.

Thank you!




  parent reply	other threads:[~2020-09-14  7:32 UTC|newest]

Thread overview: 5+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-09-11 14:08 Dylan Whyte
2020-09-11 14:21 ` Dietmar Maurer
2020-09-14  6:40   ` Dylan Whyte
2020-09-14  7:32 ` Thomas Lamprecht [this message]
2020-09-14  7:51   ` Dylan Whyte

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=7adacf0a-0896-d9fc-83e1-25730830d642@proxmox.com \
    --to=t.lamprecht@proxmox.com \
    --cc=d.whyte@proxmox.com \
    --cc=pbs-devel@lists.proxmox.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox
Service provided by Proxmox Server Solutions GmbH | Privacy | Legal