Project

General

Profile

Actions

Bug #5920

closed

pysim manual on downloads.osmocom.org is (again) not updated anymore

Added by laforge about 1 year ago. Updated about 1 year ago.

Status:
Rejected
Priority:
High
Assignee:
Category:
-
Target version:
-
Start date:
02/23/2023
Due date:
% Done:

0%

Spec Reference:

Description

We've had this at least once before (#5767) but it again is failing? The manuals (both PDF and HTML) are just about one year old by now :(

The 'docs' Makefile still works for me locally, i.e. I can get HTML and PDF rendered just the same way as contrib/jenkins.sh claims to do it. Is it simply not called anymore? But then why don't we see jenkins build jobs failing?


Related issues

Related to pySim - Feature #5270: automatically publish html manual at suitable locationResolvedlaforge10/16/2021

Actions
Related to pySim - Bug #5271: pdf manual is still dated April 2021Resolvedlaforge10/16/2021

Actions
Actions #2

Updated by laforge about 1 year ago

  • Related to Feature #5270: automatically publish html manual at suitable location added
Actions #3

Updated by laforge about 1 year ago

  • Related to Bug #5271: pdf manual is still dated April 2021 added
Actions #4

Updated by osmith about 1 year ago

  • Status changed from New to In Progress
Actions #5

Updated by osmith about 1 year ago

  • Status changed from In Progress to Feedback
  • Assignee changed from osmith to laforge

The manuals (both PDF and HTML) are just about one year old by now :(

Where do you see this, is there something specific missing in the generated manuals?

The timestamps show that the files are updated daily:

https://downloads.osmocom.org/docs/latest/

pysim/    2023-Feb-22 11:50:05    -      Directory
osmopysim-usermanual.pdf    2023-Feb-22 11:50:08    321.3K    application/pdf

The pdf here says Feb 22, 2023:
https://downloads.osmocom.org/docs/latest/osmopysim-usermanual.pdf

And the jenkins job is running and uploading the generated files, see end of the script:
https://jenkins.osmocom.org/jenkins/job/master-pysim/JOB_TYPE=docs,a1=default,a3=default,a4=default,label=osmocom-master/478/console

Actions #6

Updated by laforge about 1 year ago

  • Status changed from Feedback to In Progress
  • Assignee changed from laforge to osmith

Please note that unfortunately my sphinx-argparse patch from 2021 was not merged and meanwhile the maintainer / github repo has changed. I just ported it to the new upstream and re-submitted it at https://github.com/ashb/sphinx-argparse/pull/36

Meanwhile, we can always use https://github.com/osmocom/sphinx-argparse/tree/inside-classes

Actions #7

Updated by laforge about 1 year ago

  • Status changed from In Progress to Rejected

osmith wrote in #note-5:

Where do you see this, is there something specific missing in the generated manuals?

It seems my braind has mixed up the day (22nd) with the year (23). Sorry for that. The initial reason was that information is missing from the manuals, but that's a bug in pysim-shell.git which I'm addressing now. sorry for the noise.

Actions

Also available in: Atom PDF

Add picture from clipboard (Maximum size: 48.8 MB)