I’ve made a significant PR to XLSX.jl. It passes all tests except for the test for documentation.
I’ve never done formal documentation before, and I don’t really understand what is going on. I’ve tried reading the help for Documenter.jl but it doesn’t help me (my fault, not Documenter’s!).
I’ve tried to mimic the way docs are included from the rest of the package in the way I’ve specified mine. For example, I’ve simply added my function names to the list in api.md, like this (mine are the last 14):
# API Reference
@docs
XLSX.XLSXFile
XLSX.readxlsx
XLSX.openxlsx
XLSX.writexlsx
XLSX.sheetnames
XLSX.sheetcount
XLSX.hassheet
XLSX.Worksheet
XLSX.readdata
XLSX.getdata
XLSX.getcell
XLSX.getcellrange
XLSX.row_number
XLSX.column_number
XLSX.eachrow
XLSX.readtable
XLSX.gettable
XLSX.eachtablerow
XLSX.writetable
XLSX.writetable!
XLSX.rename!
XLSX.addsheet!
XLSX.setFormat
XLSX.setUniformFormat
XLSX.setFont
XLSX.setUniformFont
XLSX.setBorder
XLSX.setUniformBorder
XLSX.setOutsideBorder
XLSX.setFill
XLSX.setUniformFill
XLSX.setAlignment
XLSX.setUniformAlignment
XLSX.setUniformStyle
XLSX.setColumnWidth
XLSX.setRowHeight
But this is obviously not enough!
Can anyone give me any pointers?
Thanks!
( I couldn’t find a way to embed the triple ticks around the @docs section within the triple ticks I need for mark-up)