Opened 20 months ago

Last modified 10 months ago

#7103 closed change

Add docs npm script to adblockpluscore, adblockpluschrome, and adblockplusui — at Version 8

Reported by: erikvold Assignee:
Priority: Unknown Milestone: Adblock-Plus-3.4.3-for-Chrome-Opera-Firefox
Module: Platform Keywords: closed-in-favor-of-gitlab
Cc: jsonesen, tlucas, sebastian, greiner, wspee, mjethani, kzar Blocked By:
Blocking: Platform: Unknown / Cross platform
Ready: no Confidential: no
Tester: Unknown Verified working: no
Review URL(s):

https://codereview.adblockplus.org/29937555
https://codereview.adblockplus.org/29984609
https://gitlab.com/eyeo/adblockplus/adblockpluscore/merge_requests/16

Description (last modified by erikvold)

We should generate docs via jsdocs npm script instead of using python command which opens a subprocess to run jsdocs in node.

This will also reduce the dependency of these repos on the buildtools repo.

Basically convert the ./build.py docs docs to npm run docs.

Change History (8)

comment:1 Changed 20 months ago by jsonesen

  • Cc tlucas sebastian greiner wspee mjethani added
  • Review URL(s) modified (diff)
  • Status changed from new to reviewing

comment:2 Changed 20 months ago by jsonesen

  • Cc kzar added

comment:3 Changed 20 months ago by jsonesen

Manish, Winsley, Thomas,

Is this something you all are okay with? If so I have patch sets prepared. This will be useful for us to not depend on buildtools to generate docs.

comment:4 Changed 20 months ago by erikvold

  • Description modified (diff)

comment:5 Changed 20 months ago by sebastian

For reference, this is part of a larger effort to phase out (the Python-based) buildtools. The changes itself look good to me, the next step would be integrating this with GitLab CI/CD.

Last edited 20 months ago by sebastian (previous) (diff)

comment:6 Changed 20 months ago by mjethani

Makes sense to me.

comment:7 Changed 18 months ago by jsonesen

I just noticed that abpui is pretty baren from a docstring standpoint, should it still be added there? Definitely makes sense for abpchrome and abpcore

comment:8 Changed 18 months ago by jsonesen

  • Review URL(s) modified (diff)
Note: See TracTickets for help on using tickets.