ultrabug / py3status

py3status is an extensible i3status wrapper written in python
https://ultrabug.github.io/py3status/
BSD 3-Clause "New" or "Revised" License
893 stars 261 forks source link

`make html` don't aware of new module #1865

Closed azzamsa closed 4 years ago

azzamsa commented 4 years ago

Hi

I've read the Writing custom py3status modules and Developing and Contributing but I can't solve the problem. Am I missing something?

My steps:

1) add my year_progress.py to /py3status/modules 2) run make html, to check my module docs.

Thanks.

lasers commented 4 years ago

I'm not sure what to say as year_progress showed up here okay. Maybe try nuking _build.

azzamsa commented 4 years ago

it didn't shows up here.

image

I get this error when building:

/py3status/doc/configuration.rst:166: WARNING: Bullet list ends without a blank line; unexpected unindent.
/py3status/doc/configuration.rst:185: WARNING: Bullet list ends without a blank line; unexpected unindent.
/py3status/doc/configuration.rst:924: WARNING: Bullet list ends without a blank line; unexpected unindent.

full output:


Running Sphinx v2.2.0
making output directory... done
Creating screenshots...
 air_quality-0.png
 air_quality-1-aqi_moderate.png
 air_quality-2-aqi_sensitively_unhealthy.png
 air_quality-3-aqi_unhealthy.png
 air_quality-4-aqi_very_unhealthy.png
 air_quality-5-aqi_hazardous.png
 apt_updates-0.png
 arch_updates-0.png
 arch_updates-1-aur.png
 async_script-0.png
 async_script-1-example.png
 aws_bill-0.png
 backlight-0.png
 battery_level-0.png
 battery_level-1-discharging.png
 bitcoin_price-0.png
 bluetooth-0.png
 bluetooth-1-off.png
 check_tcp-0.png
 check_tcp-1-down.png
 clementine-0.png
 clock-0.png
 clock-1-london.png
 cmus-0.png
 cmus-1-paused.png
 cmus-2-stopped.png
 cmus-3-waiting.png
 coin_balance-0.png
 coin_market-0.png
 coin_market-1-losers.png
 conky-0.png
 conky-1-diskio.png
 conky-10-nvidia.png
 conky-11-bar.png
 conky-2-processes.png
 conky-3-top.png
 conky-4-top_mem.png
 conky-5-network.png
 conky-6-memory.png
 conky-7-swap.png
 conky-8-disk.png
 conky-9-nvidia.png
 deadbeef-0.png
 deadbeef-1-paused.png
 diskdata-0.png
 do_not_disturb-0.png
 do_not_disturb-1-off.png
 dpms-0.png
 dpms-1-off.png
 dropboxd_status-0.png
 dropboxd_status-1-busy.png
 dropboxd_status-2-off.png
 emerge_status-0.png
 exchange_rate-0.png
 external_script-0.png
 external_script-1-example.png
 fedora_updates-0.png
 file_status-0.png
 file_status-1-missing.png
 frame-0.png
 frame-1-closed.png
 getjson-0.png
 github-0.png
 github-1-notification.png
 gitlab-0.png
 glpi-0.png
 google_calendar-0.png
 gpmdp-0.png
 graphite-0.png
 group-0.png
 group-1-cycle.png
 group-2-cycle_again.png
 hamster-0.png
 hamster-1-inactive.png
 hddtemp-0.png
 hddtemp-1-path.png
 hddtemp-2-compact.png
 hueshift-0.png
 hueshift-1-neutral.png
 hueshift-2-cool.png
 i3block-0.png
 i3block-1-bandwidth.png
 i3pystatus-0.png
 icinga2-0.png
 icinga2-1-warning.png
 icinga2-2-critical.png
 icinga2-3-unknown.png
 imap-0.png
 insync-0.png
 insync-1-busy.png
 insync-2-offline.png
 kdeconnector-0.png
 kdeconnector-1-charging.png
 kdeconnector-2-transition.png
 kdeconnector-3-not-plugged.png
 kdeconnector-4-disconnected.png
 kdeconnector-5-unknown.png
 keyboard_layout-0.png
 keyboard_layout-1-fr.png
 keyboard_layout-2-ru.png
 keyboard_layout-3-ua.png
 keyboard_layout-4-us.png
 keyboard_locks-0.png
 keyboard_locks-1-no_locks.png
 khal_calendar-0.png
 lm_sensors-0.png
 lm_sensors-1-chip_names.png
 lm_sensors-2-sensor_names.png
 loadavg-0.png
 loadavg-1-detailed.png
 loadavg-2-percentages.png
 loadavg-3-shadesofgrey.png
 loadavg-4-shadesofblue.png
 loadavg-5-monochrome.png
 loadavg-6-htop.png
 loadavg-7-black_night.png
 loadavg-8-orange_gold.png
 mail-0.png
 mail-1-identified.png
 mail-2-individualized.png
 mail-3-no_mail.png
 mega_sync-0.png
 moc-0.png
 moc-1-paused.png
 moc-2-stopped.png
 mpd_status-0.png
 mpd_status-1-paused.png
 mpd_status-2-stopped.png
 mpris-0.png
 net_iplist-0.png
 net_rate-0.png
 netdata-0.png
 networkmanager-0.png
 networkmanager-1-wifi.png
 ns_checker-0.png
 nvidia_smi-0.png
 nvidia_smi-1-percent.png
 nvidia_temp-0.png
 online_status-0.png
 online_status-1-off.png
 pingdom-0.png
 pingdom-1-degraded.png
 pingdom-2-down.png
 player_control-0.png
 player_control-1-stop.png
 player_control-2-pause.png
 pomodoro-0.png
 pomodoro-1-running.png
 process_status-0.png
 process_status-1-not_running.png
 rainbow-0.png
 rate_counter-0.png
 rss_aggregator-0.png
 rt-0.png
 scratchpad_async-0.png
 scratchpad_counter-0.png
 screenshot-0.png
 screenshot-1-basename.png
 scroll-0.png
 selinux-0.png
 selinux-1-permissive.png
 selinux-2-disabled.png
 spaceapi-0.png
 spaceapi-1-closed.png
 speedtest-0.png
 speedtest-1-time+ping.png
 speedtest-2-details.png
 spotify-0.png
 spotify-1-paused.png
 spotify-2-stopped.png
 sql-0.png
 static_string-0.png
 sysdata-0.png
 systemd-0.png
 systemd-1-inactive.png
 systemd-2-not-found.png
 taskwarrior-0.png
 thunderbird_todos-0.png
 timer-0.png
 timer-1-running.png
 timer-2-paused.png
 timewarrior-0.png
 timewarrior-1-no_tag.png
 timewarrior-2-no_timew.png
 tor_rate-0.png
 transmission-0.png
 transmission-1-verifying.png
 transmission-2-stopped.png
 transmission-3-idle.png
 twitch-0.png
 twitch-1-offline.png
 uname-0.png
 uptime-0.png
 usbguard-0.png
 velib_metropole-0.png
 velib_metropole-1-second.png
 velib_metropole-2-no_velib.png
 vnstat-0.png
 volume_status-0.png
 volume_status-1-mute.png
 vpn_status-0.png
 vpn_status-1-off.png
 wanda_the_fish-0.png
 wanda_the_fish-1-idle.png
 wanda_the_fish-2-py3status.png
 weather_owm-0.png
 weather_owm-1-diff.png
 whatismyip-0.png
 whatismyip-1-geo.png
 whatismyip-2-mode.png
 whoami-0.png
 wifi-0.png
 window_title-0.png
 window_title_async-0.png
 wwan-0.png
 wwan-1-down.png
 wwan_status-0.png
 wwan_status-1-off.png
 xkb_layouts-0.png
 xkb_layouts-1-ru.png
 xrandr-0.png
 xrandr-1-mirror.png
 xrandr-2-single_1.png
 xrandr-3-single_2.png
 xrandr_rotate-0.png
 xrandr_rotate-1-vertical.png
 xscreensaver-0.png
 xscreensaver-1-off.png
 xsel-0.png
 yandexdisk_status-0.png
 yandexdisk_status-1-idle.png
 yandexdisk_status-2-off.png
 yubikey-0.png
building [mo]: targets for 0 po files that are out of date
building [html]: targets for 8 source files that are out of date
updating environment: [new config] 8 added, 0 changed, 0 removed
reading sources... [100%] writing_modules
py3status/doc/configuration.rst:166: WARNING: Bullet list ends without a blank line; unexpected unindent.
py3status/doc/configuration.rst:185: WARNING: Bullet list ends without a blank line; unexpected unindent.
py3status/doc/configuration.rst:924: WARNING: Bullet list ends without a blank line; unexpected unindent.
looking for now-outdated files... none found
pickling environment... done
checking consistency... done
preparing documents... done
writing output... [100%] writing_modules
generating indices...  genindexdone
writing additional pages...  searchdone
copying static files... ... done
copying extra files... done
dumping search index in English (code: en)... done
dumping object inventory... done
build succeeded, 3 warnings.

The HTML pages are in _build/html.
azzamsa commented 4 years ago

This is my PR: https://github.com/ultrabug/py3status/pull/1866

lasers commented 4 years ago

@azzamsa I put the file in /home/user/.config/i3status/py3status/year_progress.py

Run find ~/ -name year_progress.py to ensure that it's in git py3status/py3status/modules folder and not your personal modules folder. Other than that, I don't really know. :(

azzamsa commented 4 years ago

Even I've committed the file, it didn't shows up in the docs.

image

can you produce it in your side by checking out my PR?

Or is there any missing step I need to put in the doc-string file so it can be recognized?

lasers commented 4 years ago

I used cd ~/src/py3status/doc ; rm -rfv _build ; make html && firefox _build/html/modules.html on your PR. It comes out like this...

2019-11-14-004919_769x692_scrot

azzamsa commented 4 years ago

Haha, I don't know what's going on. it didn't work either.

Let's close this strange issue for now.

lasers commented 4 years ago

Late response. Maybe you need to set up a development environment by running python setup.py develop. https://py3status.readthedocs.io/en/latest/contributing.html#setting-up-a-development-environment