search

bpancras / FSDA

Flexible Statistics and Data Analysis (FSDA) extends MATLAB for a robust analysis of data sets affected by different sources of heterogeneity. It is open source software licensed under the European Union Public Licence (EUPL). FSDA is a joint project by the University of Parma and the Joint Research Centre of the European Commission.
https://uniprjrc.github.io/FSDA/
European Union Public License 1.1
0 stars 0 forks source link

Move the Documentation into the toolbox folder #4

Open bpancras opened 1 year ago

bpancras commented 1 year ago

FSDA documentation is distributed across three folders:

Move these three folders within the /toolbox folder.

Caution- files requiring update

  1. The m-files within /utilities_help build the documentation the output path of these files need to be updated
  2. Packing PRJ- add the documentation path to the PRJ file
AldoCorbelliniUNIPR commented 10 months ago

Inside MATLAB documentation (https://it.mathworks.com/help/matlab/matlab_prog/create-and-share-custom-matlab-toolboxes.html) section "Examples, Apps, and Documentation", 3rd table row, is specified the following: "Getting Started Guide -- Quick start guide for your toolbox. For the Package a Toolbox tool to recognize a Getting Started Guide, include the guide as a live script named GettingStarted.mlx in a doc subfolder within your toolbox folder." Since our GettingStarted.mlx worked well, we assumed that 'toolbox folder' was the FSDA folder, not a folder named "toolbox". Maybe this section of the documentation needs a form of disambiguation.

bpancras commented 9 months ago

Thanks for pointing this ambiguity, we will look into this.