Generating documentation for a custom app

Frappe Framework App Development
1

Dear all,

I created a custom app to generate a legal report (FEC) required in France:
https://github.com/DOKOS-IO/French-Localization
It is also meant to contain additional reports and dedicated functionalities in the future.

I would like to generate the documentation as explained at the current link:
https://frappe.github.io/frappe/user/en/guides/app-development/generating-docs

But when running: bench --site "mysite" make-docs french_localization current
the system returns:
Usage: bench frappe [OPTIONS] COMMAND [ARGS]... Error: No such command "make-docs".

Am I missing something here ?

Thanks a lot in advance for your help.

Best regards,
Charles-Henri

2

Somethings have changed I guess:

revant@revant-laptop:~/frappe-bench$ bench --help | grep docs
  build-docs                  Setup docs in target folder of target app
  write-docs                  Setup docs in target folder of target app
revant@revant-laptop:~/frappe-bench$ bench build-docs --help
Usage: bench  build-docs [OPTIONS] APP

  Setup docs in target folder of target app

Options:
  --docs-version TEXT
  --target TEXT
  --local              Run app locally
  --watch              Watch for changes and rewrite
  --help               Show this message and exit.
revant@revant-laptop:~/frappe-bench$ bench write-docs --help
Usage: bench  write-docs [OPTIONS] APP

  Setup docs in target folder of target app

Options:
  --target TEXT
  --local        Run app locally
  --help         Show this message and exit.
revant@revant-laptop:~/frappe-bench$
2 Likes
3

Thanks a lot @revant_one !

My bad I didn’t check the help.

It works with buid-docs. I will submit a change to the existing Frappe documentation in the next days.

Have a nice day! :slight_smile:

1 Like
4

@revant_one, @chdecultot: great you figured it out and sorted it out properly.

It sounds like the respective piece of the manual per https://frappe.github.io/frappe/user/en/guides/app-development/generating-docs is outdated.

May I ask you to prepare a pull request with the updates of that document, to keep this information available for everyone on ERP Next community?

Thank you.

5

@gvyshnya,

Sure I will update the documentation this week and send a pull request.

2 Likes