[pbs-devel] [PATCH docs] move custom.css from 'docs/' to 'docs/_static/'

[pbs-devel] [PATCH docs] move custom.css from 'docs/' to 'docs/_static/'

[Dylan Whyte]

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.

Signed-off-by: Dylan Whyte <d.whyte@proxmox.com>
---
 docs/{ => _static}/custom.css | 0
 1 file changed, 0 insertions(+), 0 deletions(-)
 rename docs/{ => _static}/custom.css (100%)

diff --git a/docs/custom.css b/docs/_static/custom.css
similarity index 100%
rename from docs/custom.css
rename to docs/_static/custom.css
-- 
2.20.1

Re: [pbs-devel] [PATCH docs] move custom.css from 'docs/' to 'docs/_static/'

[Dietmar Maurer]

I think _static is dynamically allocated.

also, the Makefile contains:

	cp custom.css $(BUILDDIR)/html/_static/

confused!?

> On 09/11/2020 4:08 PM Dylan Whyte <d.whyte@proxmox.com> 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.
> 
> Signed-off-by: Dylan Whyte <d.whyte@proxmox.com>
> ---
>  docs/{ => _static}/custom.css | 0
>  1 file changed, 0 insertions(+), 0 deletions(-)
>  rename docs/{ => _static}/custom.css (100%)
> 
> diff --git a/docs/custom.css b/docs/_static/custom.css
> similarity index 100%
> rename from docs/custom.css
> rename to docs/_static/custom.css
> -- 
> 2.20.1
> 
> 
> 
> _______________________________________________
> pbs-devel mailing list
> pbs-devel@lists.proxmox.com
> https://lists.proxmox.com/cgi-bin/mailman/listinfo/pbs-devel

Re: [pbs-devel] [PATCH docs] move custom.css from 'docs/' to 'docs/_static/'

[Dylan Whyte]

Oh yeah, it seems you're right.. I was using sphinx-build directly when
testing all this and didn't think to check how the Makefile actually 
manages things.. my bad..

Thanks for pointing that out!
Dylan

> On 11.09.2020 16:21 Dietmar Maurer <dietmar@proxmox.com> wrote:
> 
>  
> I think _static is dynamically allocated.
> 
> also, the Makefile contains:
> 
> 	cp custom.css $(BUILDDIR)/html/_static/
> 
> confused!?
> 
> > On 09/11/2020 4:08 PM Dylan Whyte <d.whyte@proxmox.com> 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.
> > 
> > Signed-off-by: Dylan Whyte <d.whyte@proxmox.com>
> > ---
> >  docs/{ => _static}/custom.css | 0
> >  1 file changed, 0 insertions(+), 0 deletions(-)
> >  rename docs/{ => _static}/custom.css (100%)
> > 
> > diff --git a/docs/custom.css b/docs/_static/custom.css
> > similarity index 100%
> > rename from docs/custom.css
> > rename to docs/_static/custom.css
> > -- 
> > 2.20.1
> > 
> > 
> > 
> > _______________________________________________
> > pbs-devel mailing list
> > pbs-devel@lists.proxmox.com
> > https://lists.proxmox.com/cgi-bin/mailman/listinfo/pbs-devel

Re: [pbs-devel] [PATCH docs] move custom.css from 'docs/' to 'docs/_static/'

[Thomas Lamprecht]

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!

Re: [pbs-devel] [PATCH docs] move custom.css from 'docs/' to 'docs/_static/'

[Dylan Whyte]

Hi Thomas,

You are right, and I am very sorry to have wasted that time with a silly mistake.. Lesson learned
and I assure you it won't happen again!

Dylan

> On 14.09.2020 09:32 Thomas Lamprecht <t.lamprecht@proxmox.com> wrote:
> 
>  
> 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!